3.1.1.2.10 draft-comment

The <draft-comment> element is designed to facilitate review and discussion of topic contents within the marked-up content. Use the <draft-comment> element to ask a question or to make a comment that you want 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, processors should strip them out to prevent publishing internal comments by mistake.

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), map (base), classifyMap, subjectScheme, learningBookmap, learningMap ( 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 simpletable or sl or table 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)
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap ( 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 simpletable or sl or table 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 fig or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or screen or simpletable or sl or table 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 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 simpletable or sl or table 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) shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example
map (base), classifyMap, subjectScheme, learningMap shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry
topic (technical content) shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, screen, codeblock, pd
map (technical content) shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, screen, codeblock, pd
concept shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, screen, codeblock, pd
ditabase shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, glossdef, glossUsage, glossScopeNote, screen, codeblock, pd
glossary, glossentry, glossgroup shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, glossdef, glossUsage, glossScopeNote, screen, codeblock, pd
reference shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, screen, codeblock, pd
task (strict), task (general) shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, screen, codeblock, pd
bookmap shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname, screen, codeblock, pd
machineryTask shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, reqcond, reqcontp, personnel, perscat, perskill, esttime, supequi, supply, spare, safecond, screen
learningAssessment, learningOverview, learningSummary shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcObjectivesStem, lcObjective, lcAudience, lcTime, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, lcQuestionBase, lcInstructornote, lcQuestion, lcOpenAnswer, lcFeedback, lcFeedbackCorrect, lcFeedbackIncorrect, lcAnswerContent, lcItem, lcMatchingItem
learningBookmap shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname
learningContent shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcObjectivesStem, lcObjective, lcAudience, lcTime, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, conbody, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, lcQuestionBase, lcInstructornote, lcQuestion, lcOpenAnswer, lcFeedback, lcFeedbackCorrect, lcFeedbackIncorrect, lcAnswerContent, lcItem, lcMatchingItem
learningPlan shortdesc, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcObjectivesStem, lcObjective, lcAudience, lcTime, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, lcGeneralDescription, lcGoals, lcNeeds, lcValues, lcOrgConstraints, lcEdLevel, lcAge, lcBackground, lcSkills, lcKnowledge, lcMotivation, lcSpecChars, lcWorkEnvDescription, lcPlanResources, lcProcesses, lcTaskItem, lcAttitude, lcPlanObjective, lcJtaItem, lcGapItemDelta, lcLearnStrat, lcAssessment, lcDelivery, lcQuestionBase, lcInstructornote, lcQuestion, lcOpenAnswer, lcFeedback, lcFeedbackCorrect, lcFeedbackIncorrect, lcAnswerContent, lcItem, lcMatchingItem

Inheritance

- topic/draft-comment

Example

<draft-comment author="EBP">Where's the usage information for this 
section?</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. The xml:lang attribute and its values are described in the XML Recommendation at http://www.w3.org/TR/REC-xml/#sec-lang-tag. language token or the null string #IMPLIED No
dir Specifies the directionality of text: left-to-right (ltr, the processing default) or right-to-left (rtl). The value lro indicates an override of normal bidi text presentation, forcing the element into left-to-right mode; rlo overrides normal rules to force right-to-left presentation. See The dir attribute for more information on the dir attribute. (ltr | rtl | lro | rlo | -dita-use-​conref-​target) #IMPLIED No
id-atts attribute group (id, conref, conrefend, conaction, conkeyref) A set of related attributes, described in id-atts attribute group      
select-atts attribute group (props, base, platform, product, audience, otherprops, importance, rev, status) A set of related attributes, described in select-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.

OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.