Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-13379

Determine whether the LSST LaTeX documentclass document type codes can be retired

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: lsst-texmf
    • Labels:
      None
    • Story Points:
      0.5
    • Sprint:
      Arch 2019-07-15, Arch 2019-07-22
    • Team:
      Architecture

      Description

      Currently, LSST documents generated from LaTeX source use a template that has a "document type" parameter. This parameter has documented values of "DM", "MN", and "CP" at this time, and a commonly-used but undocumented value of "SE" as well (for LSE- and LPM- documents).

      As the documentation at https://lsst-texmf.lsst.io/lsstdoc.html says:

      DM defines the document type to be a “Data Management” document. Other options include MN for minutes and CP for conference proceedings but these are holdovers from the original Gaia class file and currently have no effect on the document output. They are considered optional, but descriptive, at this time.

      I suggest that we either add "SE" to the list above or, recognizing that the document type is in fact unused in the LaTeX template (it relies on the DocuShare handle, instead), remove the mention of the document type from the lsst-texmf documentation and, opportunistically, remove the document types from existing documents when other editing actions occur.

        Attachments

          Activity

          Hide
          tjenness Tim Jenness added a comment -

          It seems the document type code causes one line to be added to the title page. I've updated the documentation.

          Another option is to infer that information from the document handle and then we can remove the docType.

          Show
          tjenness Tim Jenness added a comment - It seems the document type code causes one line to be added to the title page. I've updated the documentation. Another option is to infer that information from the document handle and then we can remove the docType.
          Hide
          gpdf Gregory Dubois-Felsmann added a comment -

          The documentation change looks good to me and covers my original concern.  I see no reason for any further changes at this time.

          Show
          gpdf Gregory Dubois-Felsmann added a comment - The documentation change looks good to me and covers my original concern.  I see no reason for any further changes at this time.

            People

            • Assignee:
              tjenness Tim Jenness
              Reporter:
              gpdf Gregory Dubois-Felsmann
              Reviewers:
              Gregory Dubois-Felsmann
              Watchers:
              Gregory Dubois-Felsmann, John Swinbank, Jonathan Sick, Tim Jenness
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel