3.1.1.2.4 desc

The <desc> element contains the description of the current element. In elements that also allow a title, such as table and fig, this is used to provide more information than is appropriate for the title. In the xref and link elements it contains a description of the target; processors may (but need not) choose to display this as hover help for a link. In the object element, desc provides alternate content to use when the context does not permit displaying the object.

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 image or lines or lq or note or hazardstatement or ol or p or pre or sl 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) (any number)
map, bookmap, classifyMap, subjectScheme, learningBookmap, learningMap ( text data or dl or image or lines or lq or note or ol or p or pre or sl or ul or boolean or cite or keyword or ph or q or term or tm or xref or state or data or data-about or foreign or unknown) (any number)
topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task ( text data or dl or parml or image or lines or lq or note or hazardstatement or ol or p or pre or codeblock or msgblock or screen or sl 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) (any number)
machineryTask ( text data or dl or image or lines or lq or note or hazardstatement or ol or p or pre or screen or sl 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) (any number)
learningAssessment, learningContent, learningOverview, learningPlan, learningSummary ( text data or dl or image or lines or lq or note or lcInstructornote or ol or p or pre or sl 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) (any number)

Contained by

Doctype Content model
topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary fig, object, xref, table, link, linklist
map (base), map (technical content), bookmap, classifyMap, subjectScheme, learningBookmap, learningMap fig, object, xref, table

Inheritance

- topic/desc

Example

<fig><title>The Handshake</title>
<desc>This image shows two hands clasped in a formal, 
business-like handshake.</desc>
<image href="handshake.jpg">
 <alt>The handshake</alt>
</image>
</fig>

Attributes

Name Description Data Type Default Value Required?
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      

Return to main page.

DITA v1.2 CD 03
Copyright © OASIS Open 2005, 2010. All Rights Reserved.