example -- sample use of the reference subject

Content Model

example ::= title, (para | programlisting | screen)+


example elements hold an example of how to use the subject of the reference. The parent node is refsect1.


example elements may take an id attribute. id attributes take name tokens, used for building links from elsewhere in the same refentry document.

Formatting Expectations

Format as a block element with the title followed by the rest of the content. If the id attribute is set, mark the location for cross referencing using the value of the attribute.