These templates are very similar to the task templates used until now, but we tried to make the distinction between to user documentation and the developer documentation a bit more clear. Also, the new structure is seamlessly integrated in the overall SAS make file mechanism so that it becomes possible to generate HTML or PostScript documentation for the whole SAS.
If your package is called, say, hello, the doc subdirectory will contain three files:
If, on the other hand, the package you are developing is made of
separate tasks, hello_pn and hello_mos say, that
warrant independent documentation, then you should edit the make file
The simplest way to go about this could be to let pkgmaker create the templates for you, then merge the contents of the doc subdirectories and adjust the make files.
Note that all sections are automatically labeled. Please do not change the label names. If you have multiple LaTeX templates, and you create them by hand, please make sure that the labels are correct by following the label naming conventions illustrated in hello_description.tex.
If you add tables or figures to your document label them according to the following model (shown for the hello package):
Replace dev with user as necessary.
A description of what items should go in what section of the LaTeX templaes can be found in the documentation of the hello package, where you also find a description of the LaTeX macros to be used in the SAS documentation.
The BibTeX file is called
sas.bib and is pat of the
At the moment this is just a copy of the file used at the
SOC, and it should contain entries for all of the XMM related
documents. Let the SAS
librarian know if you need to make new entries into this file.
In your LaTeX sources use the standard LaTeX citation commands, using labels from the bibliography file. You don't have to worry about any \bib* commands, as these are automatically generated.
The SAS BibTeX file sas.bib can be found in the subdirectory doc/lib of the package sas.