star2html command sets up a Starlink-specific environment before calling LATEX2
produce a hypertext version of a Starlink document. A typical invocation, is simply:
However, there are some optional switches which you might find useful. The full format of the
# star2html [-a author(s)] [-aux] [-c copyright_statement]
[-d document_date] [-m email_address] [-s 0|1]
[-obsolete] [-t title] [arguments for LaTeX2HTML] document
The switches (all of which are optional) have the following meanings:
- – The names of the document authors. If not supplied, the value of the command
\stardocauthors will be used. If this doesn’t exist, the name of the person running the
application will be used. The value appears in the footer of every page of the hypertext
- – This controls whether or not the document
.aux file is used. (This file is produced by
running LaTeX on the source file, and contains a description of the section numbering).
If this switch is omitted, the
.aux file is not used. This default is sensible because the
structure of the paper version may differ from the structure of the hypertext version.
For example, optional diagrams and/or sections may be specified by \htmlonly and
- – A copyright statement to override the default which will appear
in the footer of each page. The default statement is found from the \stardoccopyright
command if there is one in the document, or failing that from the environment variable
HTX_COPYRIGHT if defined, or failing that the default is: “Copyright © YYYY Council
for the Central Laboratory of the Research Councils” (where YYYY is the current
year). To prevent any copyright statement from appearing, specify "-c none" or, in the
absence of a \stardoccopyright command or explicit -c "copyright_statement", set
HTX_COPYRIGHT to "none".
- – The date when the document was created. If not supplied, the value of
the \stardocdate command will be used. If this doesn’t exist, today’s date will be used.
The value appears in the footer of every page of the hypertext version.
- – A URL pointing to the hardcopy server to be used for the document. Should
be an copy of the
hcserver script from the HTX package. If this is not set a check of the
HTX_HCSERVER is made, if that is not set then no changes to the hardcopy server
URL are made.
- – A contact e-mail address for the document. If not supplied, the value of
the environment variable HTX_EMAIL will be used. If this isn’t set, then the e-mail address
firstname.lastname@example.org” will be used. The value appears in the footer of every page
of the hypertext version. If you are only responsible for producing your own documents,
you may find it convenient to set this environment variable in your
- – This flag indicates you want to mark the document as obsolete. This is done by
displaying an image with the word OBSOLETE written into it as the background.
- – This switch controls whether the input file will be split into parts, or not, before being
processed by LATEX2
HTML. The split occurs at \section, \subsection, \sstroutine and
\routine statements. Splitting up the document may considerable speed up processing
and consequently this is the default.
- – The title of the document. If not supplied, the value of the \stardoctitle
command will be used. If this fails, a name generated from the document type will be
used. The value is used as a title for the first page, and appears in the footer of every page
of the hypertext version.
- – Any unknown arguments before the file name will be passed to
HTML (do not use the -dir and -no_subdir arguments).
- – The name of the document to be converted into HTML (the file type
Some error messages always appear, but they can usually be ignored.
Copyright © 2000-2004 Council for the Central Laboratory of the Research Councils
Copyright © 2008-2009 Science and Technology Facilities Council