Next Up Previous Contents
Next: section-samepage
Up: LaTeX parameterisation
Previous: %latex-manifest%
[ID index][Keyword index]

%latex-document-general-preamble%

Description

Any definitions which are to be emitted as part of the LaTeX preamble.

The \\Url{} command in url.sty sets URLs much better than the following does, but we want to avoid requiring non-default packages in the LaTeX we emit, so insert the following crude (but effective enough) macro to allow `hyphenation' at the dots and slashes in machine or file names, URLs, etc. The \\UrlFootnote command inserts a URL into a footnote.

The stylesheet generates relatively high-level LaTeX, rather than emitting detailed formatting codes. This means that any LaTeX hackery that's required can be confined to this `style file', and incorporated into the preamble rather than being scattered through the stylesheets.

The stylesheet must put all of the following into a FrontMatter environment. Within that, it must call \\setTitle and \\setAuthorlist, which contains a fmtAuthorlist environment containing a sequence of \\fmtAuthor commands), \\setDate. It should also call \\setDocCode with the document code (eg, `SUN/123.4') and \\setDocRef with the document description (eg, `Starlink User Note 123.4'), and set the copyright message with \\setCopyright. After these, it must call \\MakeTitle, then create a VersoTitlepage environment with any additional matter to go on the verso of the titlepage. It may then call \\TableOfContents.

Return value

Type: string

String with the LaTeX preamble in it.


Next Up Previous Contents
Next: section-samepage
Up: LaTeX parameterisation
Previous: %latex-manifest%
[ID index][Keyword index]