The example element is a section that contains examples that illustrate or support the current topic.
Use example to contain both sample code (or similar artifacts) and the discussion that illustrates the sample. For example, a DITA topic about programming code could use the example element to contain both the sample code and the text that describes the code. Similarly, a sample that included preformatted text might use the pre element along with a paragraph or list to elaborate upon sections of that text.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
- topic/example
Example
<example id="example"> <title>Example</title> <codeblock><p>Example of the p element</p></codeblock> </example>
Attributes
The following attributes are available on this element: Universal attribute group, outputclass, and spectitle.