Required-cleanupA <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.
[edit] 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 <center> tag.</required-cleanup>
</section>
[edit] Contains
| Doctype
| Content model
|
| ditabase, topic, task, reference, concept, glossary, map, bookmap
|
|
[edit] Contained by
| Doctype
| Parents
|
| bookmap
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, organizationname
|
| map
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry
|
| ditabase
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, conbody, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, glossdef, screen, codeblock, pd
|
| topic
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, screen, codeblock, pd
|
| task
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, screen, codeblock, pd
|
| concept
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, conbody, screen, codeblock, pd
|
| reference
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, screen, codeblock, pd
|
| glossary
| p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, abstract, body, section, example, conbody, glossdef, screen, codeblock, pd
|
[edit] Inheritance:
- topic/required-cleanup
[edit] 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.
| no | -dita-use-conref-target
| "no"
| No
|
| xml:lang
| Specifies the language of the element content. When no xml:lang value
is supplied, the default value of English is assumed. For example, if there
is a note element with the attribute xml:lang set to the value "es,"
then the label on the note, which normally appears as "Note" will now
appear in Spanish as "Nota." The allowed xml:lang values are
based on
RFC 4646 Tags for Identifying Languages (see [[W3C:
Language tags in HTML and XML]]).
| NMTOKEN
| #IMPLIED
| No
|
| dir
| Specifies the directionality of text: left-to-right (ltr, the processing
default) or right-to-left (rtl). See the DITA Architectural Specification
for best practices related to this attribute, and other aspects of DITA and translation.
| rtl | lro | rlo | -dita-use-conref-target)
| #IMPLIED
| No
|
| %id-atts; (id, conref)
| A set of related attributes, described at %id-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %select-atts; (props, base, platform, product, audience, otherprops,
importance, rev, status)
| A set of related attributes, described at %select-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
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Specialization elements
Previous topic: no-topic-nesting
Next topic: state
|
|
