Next Up Previous Contents
Next: 5 Documenting source code
Up: 4 The structure of the document
Previous: 4.10 Maths
[ID index][Keyword index]

4.11 Output depending on media type

Includes span.

In certain circumstances, you need to make the text of your document sensitive to the output medium. For example, when documenting a routine prologue (which documentation might reasonably be expected to be read in a character-based format such as a HLP file), you might want to write

The length is
<span media='screen,print'><m>x=r\sin \theta</m></span>
<span media='tty'><code>x = r * sin(theta)</code></span>
to give different versions based on the intended output format. For further details, and the list of output media, see the span documentation.

Note that this element can control output only within a paragraph. We may add another element - probably called div - which functions higher up the element hierarchy, but until then, you will need to use marked sections.


Next Up Previous Contents
Next: 5 Documenting source code
Up: 4 The structure of the document
Previous: 4.10 Maths
[ID index][Keyword index]
The Starlink SGML Set
Starlink System Note 70
Norman Gray, Mark Taylor
21 April 1999. Release DR-0.7-13. Last updated 24 August 2001