next up previous
Next: Hyperlinks Up: Making Hypertext documentation with Previous: Describing and referencing

Describing a data structure

 

Data structures are always described in upper case letters. A reference to a data structure described in the same document is always of the form

  \data{DATASTRUCTURE}
and a reference to a routine defined in some external hypertext document is always of the form
  \extdata{DATASTRUCTURE}
. A description of a data structure starts with a \section, \subsection, etc. command:
  \section{DATASTRUCTURE}
For correct operation of the \data and \extdata commands the label must always start with data-:
  \label{data-DATASTRUCTURE}
The data structure is then described in a straightforward manner using LaTeX commands. For summing up different components of an array we always use the description environment. So for example,
  \section{IINPUT}
  \label{data-IINPUT}

  \begin{description}
    \item [Pos. 1] - something
    \item [Pos. 2] - something else
  \end{description}



ISNaS ontwikkeling
Tue May 23 11:30:15 METDST 1995