ExampleThe <example> element is a section with
the specific role of containing examples that illustrate or support the current
topic. The <example> element has the same content
model as <section>.
DITA uses <example> to contain both discussion
and sample code or outputs. Hence, in a DITA topic, to represent programming
code and results within the discussion in an example, use the <codeblock>
and <systemoutput> elements within the example element.
For lines of text, use the <lines> element. For pre-formatted
text such as email headers, use the <pre> element.
[edit] Contains
[edit] Contained by
[edit] Inheritance:
- topic/example
[edit] Attributes
| Name
| Description
| Data Type
| Default Value
| Required?
|
| spectitle
| The specialized title attribute allows architects of specialized
types to define a fixed or default title for a specialized element. Not intended
for direct use by authors.
| CDATA
| #IMPLIED
| No
|
| %univ-atts; (%select-atts;, %id-atts;, %localization-atts;)
| A set of related attributes, described at %univ-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %global-atts; (xtrf, xtrc)
| A set of related attributes, described at %global-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| class, outputclass
| Common attributes described in Other common DITA attributes
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Topic elements
Previous topic: section
Next topic: related-links
|
|
