required-cleanup

Darwin Information Typing Architecture (DITA) Version 1.3 Part 1: Base Edition

version
1.3
author
OASIS DITA Technical Committee

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.

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

Content models

See appendix for information about this element in OASIS document type shells.

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

The following attributes are available on this element: Universal attribute group (with a modified definition of translate, given below), outputclass, and the attributes defined below.
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).
translate
Indicates whether the content of the element should be translated or not. The default value for this element is "no"; setting to "yes" will override the default. The -dita-use-conref-target value is also available. 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.