Voici quelques éléments avancés plus courants dans DITA :
|
<section>
|
Élément qui divise le corps d’un sujet en sous-sections avec des titres individuels. L’élément <section> peut contenir un élément <title> pour lui donner un titre, ainsi que la plupart des éléments autorisés à l’intérieur de l’élément <conbody>. Cependant, l’élément <section> ne peut pas contenir d’autres éléments <section> et ne peut être suivi que d’un autre élément <section>, d’un élément <exemple> ou d’un élément <conbodydiv>.
Remarque :
Si vous constatez que vous ajoutez de nombreuses sections ou des sections d’une longueur importante à une rubrique, faites plutôt de chacune de ces sections une rubrique propre afin de pouvoir réutiliser l’information plus facilement.
|
|
<draft-comment>
|
Élément qui permet d’insérer des commentaires et des questions dans le contenu pendant son élaboration. Par défaut, l’élément <draft-comment> est caché dans la publication finale, vous pouvez donc présenter la publication sans supprimer tous les commentaires. (Vous devez cependant décider si vous êtes prêt à prendre le risque).
|
|
<required-cleanup>
|
Élément qui vous permet d’envelopper le contenu qui est mal étiqueté et qui doit être corrigé. Par défaut, tout contenu à l’intérieur de l’élément <required-cleanup> est caché dans la sortie.
|
Pratique
- Continuez d’utiliser le fichier leçon4/l_concept_avance_debut.dita pour ajouter chacun de ces éléments dans votre fichier d’exemple.
- Après l’élément <lq>, ajoutez un élément <section> tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
</lq>
<section>
</section>
</conbody>
</concept>
Dans l’exemple ajouté, vous créez une sous-section à la rubrique « Écrire sur les canards ».
- À l’intérieur de l’élément <section>, ajoutez les éléments <title> et <p> et ajoutez-y du contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
<section>
<title>Partager votre base de données sur les canards</title>
<p>Exportez votre base de données sur les canards sous forme de publication HTML pour la rendre facile à partager sur votre site internet.
Vous pouvez également proposer votre base de données aux utilisateurs sous forme de téléchargement.</p>
</section>
</conbody>
</concept>
Un seul élément <title> est autorisé à l’intérieur de l’élément <concept> où un titre existe déjà. Cependant, en ajoutant un élément <section>, vous pouvez avoir plusieurs sous-titres dans votre concept. Comme pour l’élément <concept>, chaque élément <section> ne peut contenir qu’un seul élément <title>.
Un élément <section> peut contenir les mêmes éléments de corps qu’un élément <conbody>, à l’exception d’un autre élément <section> (c’est-à-dire que vous ne pouvez pas emboîter les éléments <section> les uns dans les autres).
- Après l’élément <p> dans la nouvelle section, ajoutez un élément <draft-comment> et son contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
</p>
<draft-comment>Êtes-vous sûr de vouloir proposer un téléchargement ?</draft-comment>
...
</conbody>
</concept>
Dans l’exemple ajouté, vous dites aux autres auteurs qui pourraient travailler sur cette rubrique de reconsidérer la décision de proposer un téléchargement.
- A la fin du contenu de l’élément <section> (avant la balise de fermeture), ajoutez un élément <required-cleanup> et son contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="cconcept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
<required-cleanup>
<p>Envisagez de donner aux utilisateurs la possibilité d'envoyer des commentaires ou des suggestions d'entrées
pour votre base de données sur les canards.</p>
</required-cleanup>
</section>
</conbody>
</concept>
Dans cet exemple, vous avez entouré l’élément <p> avec l’élément <required-cleanup> pour indiquer qu’il doit être déplacé à un endroit valide (comme à l’intérieur de l’élément <section>) ou être ré-étiqueté avec un élément valide (comme l’élément <example>). Sinon, vous ne pourrez pas produire de publication à cause de la présence d’éléments non valides.
- Vérifiez votre fichier leçon4/l_concept_avance_debut.dita à l’aide du fichier exemple leçon4/l_concept_avance.dita.
Pratique
- Ouvrez le fichier leçon4/l_concept_avance_exercice_debut.dita et utilisez-le pour convertir le contenu suivant :
Développer une stratégie de contenu technique
Après avoir passé en revue l’information produits existante, vous devriez disposer d’une liste des défis et des idées d’amélioration du contenu. Voici quelques scénarios courants.
Réutilisation entre la documentation technique et le matériel de formation
Le service de formation utilise les informations de référence et de tâches créées par l’équipe de documentation technique, mais les concepteurs pédagogiques font des copier-coller au lieu d’établir des liens car les deux groupes utilisent des outils de création de contenu différents et incompatibles.
Commentaire : Ajouter : « Si les deux équipes s’uniformisaient sur un seul processus de travail, elles pourraient partager le contenu de manière transparente et éviter de nombreuses reprises fastidieuses. »
Une publication HTML est nécessaire en plus du PDF
Votre contenu devrait ressembler à ceci en HTML :
<div class="p">Vous pouvez produire des contenus de grande valeur, tels que les suivants :
<ul class="ul">
<li class="li"><p class="p">Matériels de formation</p></li>
<li class="li"><p class="p">Livres blancs</p></li>
<li class="li"><p class="p">Articles de la base de connaissances</p></li>
</ul>
</div>
l’élément <div> contient une liste non-ordonnée.
Le contenu technique est obsolète en raison d’un processus de mise à jour inefficace
Le processus de production des livres – la génération de tables des matières et d’index, la vérification de la pagination, la création de journaux de pages modifiées et autres tâches similaires – prend beaucoup de temps. Par conséquent, les livres ne sont mis à jour que deux fois par an. Mais le produit change tous les trimestres, voire tous les mois, de sorte que la documentation technique est presque toujours périmée. Les lecteurs se plaignent du manque de synchronisation entre les mises à jour du produit et les mises à jour du contenu.
- Vérifiez votre fichier leçon4/l_concept_avance_debut.dita avec le fichier exemple leçon4/l_concept_avance_exercice.dita.
Contributeurs
