7.3 External labels

L^ATEX2HTML has a way to extend the label cross-referencing across documents. The list of label references is stored in the same directory as the .html and .gif output in a perl file called labels.pl. One document can cross-reference another's labels via the \externallabels command, as in the following example:

\externallabels{Coding_URL}%
               {/aips++/docs/reference/Coding/labels.pl}
\externallabels{HowTos_URL}%
               {/aips++/docs/reference/HowTos/labels.pl}
\externallabels{System_URL}%
               {/aips++/docs/reference/System/labels.pl}

The first argument is the URL to the directory containing the external document; the second is the full pathname to the labels.pl file containing the external document. Hypertext links can then be made to any of the documents whose label files have been imported in this way, using the command:

\htmlref{label_name_used_in_external_document}

This approach has the merit that if the labels.pl files in the external documents become expanded (but their directory locations stay the same), hypertext references in the documents that call them can be updated simply by rerunning L^ATEX2HTML on the calling documents.

To take full advantage of external labeling in a complex documentation package, the label-naming scheme might be extended to doc-label:fig:text for figures, doc-label:eqn:text for equations, etc., wherein the doc-label strings distinguish entire documents.

Home | Contact Us | Directories | Site Map | Help | Search