draft-comment

The <draft-comment> element allows simple review and discussion of topic contents within the marked-up content. Use the <draft-comment> element to ask a question or make a comment that you would like others to review. To indicate the source of the draft comment or the status of the comment, use the author, time or disposition attributes.

Processing systems should provide a run-time flag or parameter to cause the content of this element to be specially displayed for draft output only. By default, it is stripped out to prevent publishing internal comments by mistake.

Example

<draft-comment author="EBP">Where's the usage information for this 
section?</draft-comment>

Contains

Doctype Content model
ditabase, topic, task, reference, concept ( 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 data or data-about or foreign or unknown) (any number)
map, bookmap ( text data or ph or term or xref or cite or q or boolean or state or keyword or tm or p or lq or note or dl or ul or ol or sl or pre or lines or fig or image or object or table or simpletable or data or data-about or foreign or unknown) (any number)

Contained by

Doctype Parents
bookmap p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname
map p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry
ditabase p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, glossdef, screen, codeblock, pd
topic p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, screen, codeblock, pd
task p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, screen, codeblock, pd
concept p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, screen, codeblock, pd
reference p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, screen, codeblock, pd
glossary p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, section, example, glossdef, screen, codeblock, pd

Inheritance:

- topic/draft-comment

Attributes

Name Description Data Type Default Value Required?
author Designates the originator of the draft comment. CDATA #IMPLIED No
time Describes when the draft comment was created. CDATA #IMPLIED No
disposition Status of the draft comment. Values can be issue, open, accepted, rejected, deferred, duplicate, reopened, unassigned, or completed. CDATA #IMPLIED No
translate Indicates whether the content of the element should be translated or not. Setting to "yes" will override the default. The DITA architectural specification contains a list of each OASIS DITA element and its common processing default for the translate value; because this element uses an actual default, it will always be treated as translate="no" unless overridden as described. yes | no | -dita-use-conref-target "no" No
xml:lang Specifies the language of the element content. When no xml:lang value is supplied, the default value of English is assumed. For example, if there is a note element with the attribute xml:lang set to the value "es," then the label on the note, which normally appears as "Note" will now appear in Spanish as "Nota." The allowed xml:lang values are based on RFC 4646 Tags for Identifying Languages (see W3C: Language tags in HTML and XML). NMTOKEN #IMPLIED No
dir Specifies the directionality of text: left-to-right (ltr, the processing default) or right-to-left (rtl). See the DITA Architectural Specification for best practices related to this attribute, and other aspects of DITA and translation. (ltr | rtl | lro | rlo | -dita-use-conref-target) #IMPLIED No
%id-atts; (id, conref) A set of related attributes, described at %id-atts; parameter entity PE not applicable Not applicable
%select-atts; (props, base, platform, product, audience, otherprops, importance, rev, status) A set of related attributes, described at %select-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      

Return to main page.

OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.