12.3. required-cleanup

On utilise un élément <required-cleanup> comme conteneur pour des éléments migrés qui ne peuvent pas être marqués de façon appropriée sans intervention manuelle. Comme le nom de l'élément l'implique, le but pour les auteurs est de nettoyer la matière contenu et éventuellement de se débarasser de l'élément <required-cleanup>. Les auteurs ne devraient pas insérer cet élément dans les documents.

Note : Puisque le contenu de <required-cleanup> n'est pas considéré comme étant des données vérifiées, les processeurs DITA ont l'obligation par défaut de supprimer cet élément de la sortie. Un drapeau d'exécution PEUT être fourni afin de permettre une vue en mode brouillon du contenu migré dans le contexte.

Exemple

En supposant qu'un document HTML original ait contenu quelque chose dans une balise <center> (pour laquelle il n'existe pas d'équivalent clair dans DITA), voici un résultat qui serait valide dans un éditeur XML mais qui nécessite un rédacteur pour décider comment mieux baliser ou réviser ce contenu premier :

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

Contient :

Doctype Modèle de contenu
ditabase, topic, task, reference, concept, glossary, map, bookmap  

Contenu par :

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

Héritage :

- topic/required-cleanup

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
remap Indique l'élément auquel le contenu l'élément <required-cleanup> est associé (fournit une idée de ce que la nouvelle intention devrait être). CDATA #IMPLIED non
translate Indique si le contenu de l'élément devrait être traduit ou non. La valeur "yes" remplacera la valeur par défaut. La spécification architecturale DITA contient une liste de tous les éléments DITA OASIS et leur valeur de traitement par défaut courante pour translate ; puisque l'élément utilise une valeur par défaut réelle, il sera toujours traité avec translate="no" sauf remplacement comme décrit. yes | no | -dita-use-conref-target "no" non
xml:lang Spécifie la langue du contenu de l'élément. Si aucune valeur xml:lang n'est fournie, la langue supposée est l'anglais par défaut. Par exemple, si l'attribut xml:lang d'un élément <note> a la valeur "es", alors l'intitulé de la note, normalement affiché « Note », s'affichera « Nota » en espagnol. Les valeurs xml:lang admises sont celles du document RFC 4646 Étiquettes d'identification des langues (cf. W3C — Étiquettes de langue en HTML et XML). NMTOKEN #IMPLIED non
dir Spécifie la directionnalité du texte : gauche-à-droite ("ltr", traitement par défaut) ou droite-à-gauche ("rtl"). Cf. la spécification architecturale DITA pour les pratiques exemplaires liées à cet attribut, et d'autres aspects de DITA et la traduction. (ltr | rtl | lro | rlo | -dita-use-conref-target) #IMPLIED non
%id-atts; (id, conref) Un ensemble d'attributs liés, décrit à la section 25.3. %id-atts; entité paramètre sans objet pour une entité paramètre sans objet
%select-atts; (props, base, platform, product, audience, otherprops, importance, rev, status) Un ensemble d'attributs liés, décrit à la section 25.5. %select-atts; entité paramètre sans objet pour une entité paramètre sans objet
%global-atts; (xtrf, xtrc) Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts; entité paramètre sans objet pour une entité paramètre sans objet
class, outputclass Attributs communs, décrit à la section 25.9. Autres attributs DITA communs