QR code for this page

Powered by Titania Delivery

required-cleanup

A <required-cleanup> element is used as a placeholder for migrated elements that cannot be appropriately tagged without manual intervention. As the element name implies, the intent for authors is to clean up the contained material and eventually remove the <required-cleanup> element. Authors should not insert this element into documents.

Note

  • Processors must strip this element from output by default. The content of <required-cleanup> is not considered to be verified data.
  • Processor options may be provided to allow a draft view of migrated content in context.

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, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary ANY

Contained by

Doctype Content model
topic (base) p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example
map (base), classifyMap, subjectScheme, learningMap p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry
topic (technical content) p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, screen, codeblock, pd
map (technical content) p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, screen, codeblock, pd
concept p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, bodydiv, section, sectiondiv, example, conbody, screen, codeblock, pd
ditabase 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 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 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) 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 p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname, screen, codeblock, pd
machineryTask 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 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 p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname
learningContent 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 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/required-cleanup

Example

Presuming an original HTML document had contained some content within a <center> tag (for which there is no clear migrational equivalent in DITA), the following might be the result that is valid within an XML editor, but which requires an author to decide how to better tag or revise this original content: 

<section>
  <title>Some section title</title>
  <required-cleanup remap="center">Some original content migrated
  from a &lt;center> tag.</required-cleanup>
</section>

Attributes

Name Description Data Type Default Value Required?
remap Indicates the element that the contents of the required-cleanup element were mapped from (provides an idea about what the new intent should be). 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
Parent topic: Legacy conversion elements

Was this helpful?