XMM-Newton Science Analysis System


oal (oal-3.115) [xmmsas_20070308_1802-6.6.0]

Meta Index / Home Page / Developer's notes / Using OAL in a

References to User-Level documentation

Tasks making use of the OAL inherit all it's functionality which is documented in the above User Section. This information should be propagated into the documentation of the task availing the OAL by including a phrase such as:

For a description of the functionality offered by the OAL please consult the OAL User Documentation.

followed by a statement

    \externalref{oal:user}

in the file taskname_description.tex. The $\backslash$externalref command produces a cross reference to the relevant documentation in the OAL package. For this to work, in addition, the file taskname.tex must contain a statement

    \externallabels{.../oal/doc/oal}{.../oal/doc/oal/labels.pl}

where ... must be replaced by the relative path from the directory containing the task's HTML documentation to the SAS top-level package directory (usually ../../..).