<required-cleanup>
Required cleanup sections are placeholders for migrated elements that cannot be appropriately tagged without manual intervention, or for content that must be cleaned up before publishing.
Usage information
As the element name implies, the intent for authors is to clean up the contained material
and eventually remove the <required-cleanup> element.
Rendering expectations
Processors MUST strip this element from output by
default. The content of <required-cleanup> is not considered to be
publishable data.
Processing expectations
Processor options might be provided to allow a draft view of migrated content in context.
Content model
Any
Contained by
<abstract>
,
<alt>
,
<b>
,
<body>
,
<bodydiv>
,
<cite>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<i>
,
<keyword>
,
<li>
,
<line-through>
,
<lines>
,
<linkinfo>
,
<linktitle>
,
<lq>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<ph>
,
<pre>
,
<q>
,
<searchtitle>
,
<section>
,
<shortdesc>
,
<sli>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<term>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<u>
,
<xref>
Any content
Contained by
-
<abstract> -
<alt> -
<b> -
<body> -
<bodydiv> -
<cite> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<i> -
<keyword> -
<li> -
<line-through> -
<lines> -
<linkinfo> -
<linktitle> -
<lq> -
<navtitle> -
<note> -
<overline> -
<p> -
<ph> -
<pre> -
<q> -
<searchtitle> -
<section> -
<shortdesc> -
<sli> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<term> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<u> -
<xref>
Inheritance
- topic/required-cleanup
The <required-cleanup> element is a base element type. It is defined in the topic module.
Attributes
The following attributes are available on this element: universal attributes and the attribute defined below.
For this element, the @translate attribute has a default value of
no.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
In the following example, an HTML document that used the <center>
element was migrated to DITA. Because DITA has no clear equivalent element, the content is
stored in <required-cleanup> until it can be marked up
appropriately.
<section>
<title>Using the display</title>
<required-cleanup remap="center">If you cannot read
your display, see "Adjusting the language setting"
before you continue.</required-cleanup>
</section>