This subroutine class produces an HTML documentation
header file which will serve as a home page for a
The page created by this generic class is largely blank,
so most missions need to have their own sub-class which
fills in more information.
This class provides a number of methods which may be used
to format HTML, such that sub-classes
should not need to explicitly use any HTML tags.
Sub-classes could over-ride these methods to produce
a page in something other than HTML.
First inherit init stuff and then
generate the header file top.
Empty body - specific missions should over-ride this
to fill in the contents of the header page.
Generate the links to other pages which are found at the top of the page.
Sub-classes should override this method to add more links.
First put the closing HTML tags in the header page, then
record the name of the header page in the job.par
and finally do inherited cleanup stuff.
Begin a document section with the given heading.
End a document section. This doesn't actually do anything,
but you should use it in case a subclass wanted to do something special
Begin a bulleted list.
End a bulleted list.
- item(name, value, name, value...)
Add an element to a bulleted list.
Each item is a set of name-value pairs which will appear
on the same line. Usually there is only one name-value pair,
but sometimes it is useful to put two things (e.g. R.A. and Dec.)
on the same line.
- pi_info(prefix, type)
Generate a standard section giving name and address information
for a given PI.