Éléments de commentaires, draft-comment et required-cleanup

Les normes XML de balisage des commentaires, et les éléments spécifiques à DITA draft-comment et required-cleanup, permettent aux auteurs de laisser des notes, des commentaires et des éditions non-achevées qui seront exclus du document de sortie lors de sa publication.

Le balisage des commentaires en XML peut être incorporé dans les documents DITA puisqu'il s'agit, bien évidemment, de documents XML. Ces commentaires sont délimités par un préfixe <!-- et un suffixe -->.

<p>Le poids [kerb] de ce véhicule est de 1 395 kg.</p>
<!-- Vérifier l'exactitude du poids pour le modèle XRW -->

L'élément phrase draft-comment est une alternative au commentaire XML, spécifique à DITA, dont l'objectif reste le même.

Utilisez l'élément draft-comment ou le commentaire XML si vous souhaitez laisser des commentaires ou des notes destinés à d'autres auteurs. Préférez l'élément draft-comment au commentaire XML car il est possible d'inclure volontairement du contenu draft-comment dans le document de sortie pour la révision et l'édition.

<p>Le poids [kerb] de ce véhicule est de 1 395 kg.
<draft-comment>Vérifier l'exactitude du poids pour le modèle XRW</draft-comment>
</p>

L'élément bloc required-cleanup est utilisé pendant la migration dans DITA d'un ancien contenu (pré-DITA) et permet de préserver ce qui serait considéré comme un balisage invalide au moment de la conversion. Cet élément est celui qui est le plus souvent utilisé par les processus de conversion automatique tels que le H2D HTML pour la transformation DITA, fourni dans le DITA Open Toolkit.

L'élément required-cleanup peut contenir tout balisage bien formé.

N'utilisez pas l'élément required-cleanup à d'autres fins que pour l'identification du balisage DITA invalide nécessitant une correction.