`<example>`

An example illustrates the subject of the topic or a portion of the topic.

Usage information

For maximum flexibility in creating specializations, examples allow plain text as well as phrase and block level elements. Because of the way XML grammars are defined within a DTD, any element that allows plain text cannot restrict the order or frequency of other elements. As a result, the <example> element allows <title> to appear anywhere as a child of <example>. However, the intent of the specification is that <title> only be used once in any <example>, and when used, that it precede any other text or element content.

Rendering expectations

Processors SHOULD treat the presence of more than one <title> element in a <example> element as an error.

Content model

(Text | <audio> | <dl> | <div> | <imagemap> | <fig> | <image> | <lines> | <lq> | <note> | <hazardstatement> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <strong> | <em> | <b> | <i> | <line-through> | <overline> | <sup> | <sub> | <tt> | <u> | <q> | <term> | <text> | <tm> | <xref> | <data> | <sort-as> | <foreign> | <title> | <draft-comment> | <fn> | <indexterm> | <required-cleanup> )*

Zero or more

Attributes

The following attributes are available on this element: universal attributes.

Example

This section is non-normative.

The following code sample shows an <example> element that contains a code block and a textual explanation of it:

<section id="AddingRecord">
  <title>ADD</title>
  <p>New database records are created using the <cmdname>ADD</cmdname> command.</p>
  <example>
    <p>The following example illustrates the creation of a new record. All parameter settings 
       are strictly optional.</p>
    <codeblock>01 OPTIONS ABC,ADD,DEF,HIJK,LMNO,AOW=25000,HF=2</codeblock>
  </example>
</section>