Ajouter des éléments de base à un concept

Certains des éléments les plus couramment utilisés dans un concept sont :

<p>

paragraphe

<ul>

liste non-ordonnée

<ol>

liste ordonnée

<note>

mise en garde

Ces éléments sont abordés dans le cours Introduction à DITA . Cette leçon donne un bref aperçu de ces éléments et montre comment les ajouter à un concept.

Pratique
  1. Continuez d’utiliser le fichier leçon1/l_nouveau_concept_debut.dita.
  2. À l’intérieur de l’élément <conbody>, ajouter un élément <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="mon_premier_concept">
       <title>Espèces de canards sauvages</title>
       <conbody>
          <p>Les canards sauvages d'Amérique du Nord appartiennent à l'une des catégories suivantes :</p>
       </conbody>
    </concept>

    L’élément <p> est pour le corps du texte. Il peut être utilisé dans l’élément <conbody> aussi bien qu’à l’intérieur des nombreux éléments contenus par <conbody>.

    Remarque :

    Utilisez l’élément <p> pour tout corps de texte qui n’a pas besoin d’une balise d’élément plus spécifique. Comme vous le verrez dans les exemples de ce cours, nous vous recommandons d’utiliser l’élément <p> pour baliser le texte à l’intérieur des points de liste, des notes et des entrées de tableau. Les éléments <p> sont nécessaires pour les points de liste qui font plusieurs paragraphes, et encadrer des points individuels par l’élément <p> leur conserve une cohérence.

    L’élément <p> que vous venez de créer introduit l’élément suivant : une liste non-ordonnée.
  3. Après l’élément <p>, ajoutez un élément <ul> 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="mon_premier_concept">
       <title>Espèces de canards sauvages</title>
       <conbody>
          ...
          <ul>
             <li><p>Canards de surface</p></li>
             <li><p>Canards plongeurs</p></li>
             <li><p>Canards marins</p></li>
             <li><p>Canards siffleurs</p></li>
             <li><p>Cygnes et oies</p></li>
          </ul>
       </conbody>
    </concept>

    Remarque :

    Si vous utilisez un éditeur DITA, l’éditeur peut insérer automatiquement, pour vous, un attribut ID à l’élément <ul>.

    L’élément <ul> est pour une liste à puces ou non-ordonnée.
    L’élément <ul> peut seulement contenir des éléments <li>, et doit en contenir au moins un.
    Chaque élément <li> contient le texte d’une entrée à puces de la liste. Dans cet exemple, les éléments <li> suivent la meilleure pratique d’encadrer le texte par un élément <p>.
  4. Après l’élément <ul>, ajoutez un élément <ol> avec un élément <p> d’introduction 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="mon_premier_concept">
       <title>Espèces de canards sauvages</title>
       <conbody>
          ...
          <p>Les plus longues espèces de canards de surface en Amérique du Nord sont :</p>
          <ol>
             <li><p>Canard pilet</p></li>
             <li><p>Canard colvert</p></li>
             <li><p>Canard noir</p></li>
          </ol>
       </conbody>
    </concept>

    Remarque :

    Si vous utilisez un éditeur DITA, l’éditeur peut insérer automatiquement, pour vous, un attribut ID à l’élément <ol>.

    L’élément <ol> est pour une liste numérotée ou ordonnée.
    Comme l’élément <ul>, l’élément <ol> peut seulement contenir des éléments <li>, et doit en contenir au moins un.
    Dans cet exemple, chacun des éléments <li> suit la meilleure pratique d’encadrer le texte par un élément <p>.

    Remarque :

    Utilisez l’élément <ol> uniquement pour montrer que les éléments de la liste devraient apparaître dans un certain ordre, non pour créer des instructions pas-à-pas. Pour des instructions pas-à-pas, utilisez une tâche à la place.

  5. Après l’élément <ol>, ajoutez un élément <note> 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="mon_premier_concept">
       <title>Espèces de canards sauvages</title>
       <conbody>
          ...
          <note><p>Bien que le canard pilet soit le canard de surface le plus long,
             le canard colvert est généralement considéré comme le plus gros en raison de son poids corporel plus lourd.</p></note>
       </conbody>
    </concept>

    L’élément <note> est utilisé pour ajouter des mises en garde, telles que des notes, des alertes ou des avertissements, au concept. L’élément <note> que vous venez de créer suit la meilleure pratique consistant à encadrer le texte avec un élément <p>.
  6. Comparez votre fichier leçon1/l_nouveau_concept_debut.dita avec le fichier d’exemple leçon1/l_nouveau_concept.dita.
Pratique
  1. Ouvrez le fichier leçon1/l_nouveau_concept_exercice_debut.dita et utilisez-le pour convertir en DITA le contenu suivant :

    Stratégie de contenu et objectifs commerciaux

    Les questions à considérer sont :

    • Le coût réel d’une documentation à faible coût.
    • Comment créer un processus de développement de contenu efficace.
    • Si une documentation de haute qualité peut réduire le coût du support technique.
    • Le moyen le plus rentable de partager du contenu technique à l’échelle de l’entreprise.

    Note : Ignorer le contenu peut avoir d’énormes répercussions sur les coûts à l’échelle de l’organisation.

    Pour réaliser votre projet et améliorer vos chances de succès, nous vous recommandons de suivre ces étapes :

    1. Identifier et interviewer les parties prenantes.
    2. Établir des objectifs et des paramètres de mise en œuvre.
    3. Définir les rôles et les responsabilités.
    4. Établir des échéanciers et des jalons.
    5. Construire le système de création de contenu.
    6. Convertir le contenu existant.
    7. Livrer le contenu.
    8. Capturer les connaissances du projet.
    9. Assurer le succès à long terme.

  2. Comparez votre fichier leçon1/l_nouveau_concept_exercice_debut.dita avec le fichier d’exemple leçon1/l_nouveau_concept_exercice.dita.
Contributeurs