Chapter 3, Section 2.2.21. chdesc

2.2.21. chdesc

The <chdesc> element is a description of an option that a user chooses while performing a step to accomplish a task. It explains why the user would choose that option and might explain the result of the choice when it is not immediately obvious.

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
ditabase, 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 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 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 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 or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)
learningContent	( 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 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 or draft-comment or fn or indextermref or indexterm or required-cleanup) (any number)

Contained by

Doctype	Content model
ditabase, task (strict), task (general), machineryTask, learningContent	chrow

Inheritance

- topic/stentry task/chdesc

Example

<step><cmd>Then this</cmd>
 <substeps>
  <substep importance="optional"><cmd>which is done by doing this</cmd></substep>
  <substep importance="required"><cmd>and then this.</cmd></substep>
 </substeps>
 <choicetable>
  <chrow><choption>Do this</choption>
     <chdesc>and this will happen</chdesc></chrow>
  <chrow><choption>Do that</choption>
     <chdesc>and that will happen</chdesc></chrow>
 </choicetable>
</step>

Attributes

Name	Description	Data Type	Default Value	Required?
specentry	The specialized entry attribute allows architects of specialized types to define a fixed or default header title for a specialized stentry 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

‣ Parent topic: Section 2.2. Task elements

‣ Previous topic: Section 2.2.20. choption

‣ Next topic: Section 2.2.22. choices