example

The <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.

Contains

Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.

Doctype	Content model
topic (base)	( text data or dl or fig or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or simpletable or sl or table or ul or boolean or cite or keyword or ph or b or i or sup or sub or tt or u or q or term or tm or xref or state or data or data-about or foreign or unknown or title or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)
topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task	( text data or dl or parml or fig or syntaxdiagram or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or codeblock or msgblock or screen or simpletable or sl or table or ul or boolean or cite or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or ph or b or i or sup or sub or tt or u or codeph or synph or filepath or msgph or systemoutput or userinput or menucascade or uicontrol or q or term or abbreviated-form or tm or xref or state or data or data-about or foreign or unknown or title or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)
machineryTask	( text data or dl or fig or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or screen or simpletable or sl or table or ul or boolean or cite or keyword or wintitle or ph or b or i or sup or sub or tt or u or menucascade or uicontrol or q or term or tm or xref or state or data or data-about or foreign or unknown or title or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)
learningAssessment, learningContent, learningOverview, learningPlan, learningSummary	( text data or dl or fig or imagemap or lcInteractionBase or lcTrueFalse or lcSingleSelect or lcMultipleSelect or lcSequencing or lcMatching or lcHotspot or lcOpenQuestion or image or lines or lq or note or lcInstructornote or object or ol or p or pre or simpletable or sl or table or ul or boolean or cite or keyword or ph or b or i or sup or sub or tt or u or q or term or tm or xref or state or data or data-about or foreign or unknown or title or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)

Contained by

Doctype	Content model
topic (base), topic (technical content), learningAssessment, learningOverview, learningPlan, learningSummary	body
concept, glossary, glossentry, glossgroup	body, conbody, conbodydiv
ditabase	body, conbody, conbodydiv, taskbody, refbody, refbodydiv
reference	body, refbody, refbodydiv
task (strict), task (general), machineryTask	body, taskbody
learningContent	body, taskbody, conbody, conbodydiv, refbody, refbodydiv

Inheritance

- topic/example

Example

<example id="example">
  <title>Example</title>
  <codeblock>&lt;p&gt;Example of the p element&lt;/p&gt;</codeblock>
</example>

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 attribute group (includes select-atts, id-atts, and localization-atts groups)	A set of related attributes, described in univ-atts attribute group
global-atts attribute group (xtrf, xtrc)	A set of related attributes, described in global-atts attribute group
class, outputclass	Common attributes described in Other common DITA attributes

3.1.1.2.12 example

Contains

Contained by

Inheritance

Example

Attributes