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.


Contents

[edit] 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>

[edit] Contains

Doctype Content model
ditabase, task (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 draft-comment or required-cleanup or fn or indextermref or indexterm or data or data-about or foreign or unknown) (any number)

[edit] Contained by

Doctype Parents
ditabase, task chrow

[edit] Inheritance:

- topic/stentry task/chdesc


[edit] 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; (%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: Task elements
Previous topic: choption
Next topic: choices

Retrieved from "http://www.ditawiki.org/index.php/Chdesc"

This page has been accessed 218 times. This page was last modified 23:46, 11 July 2007.





This page
Discuss this page
Post a comment
Printable version
My pages
Log in / create account