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 get rid of the <required-cleanup> element. Authors should not insert this element into documents.

Note: Because the content of <required-cleanup> is not considered to be verified data, DITA processors are required to strip this element from output by default. A runtime flag may be provided to allow a draft view of migrated content in context.

Contains

Contained by

body, section, example, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, conbody, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, screen, codeblock, pd

Inheritance

topic/required-cleanup

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
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang) 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

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>