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

Doctype	Content model
ditabase, topic, task, reference, concept, glossary	( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or title or draft-comment or required-cleanup or fn or indextermref or indexterm or data or data-about or foreign or unknown) (any number)

Doctype

Content model

ditabase, topic, task, reference, concept, glossary

( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or title or draft-comment or required-cleanup or fn or indextermref or indexterm or data or data-about or foreign or unknown) (any number)

Contained by

Doctype	Parents
ditabase	body, conbody, taskbody, refbody
topic	body
task	body, taskbody
concept	body, conbody
reference	body, refbody
glossary	body, conbody

Inheritance:

- topic/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; (%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

Parent topic: Topic elements

Previous topic: section

Next topic: related-links

Return to main page.