Comment utiliser les métadonnées ?

Introduction à DITA Leçon 3 : Métadonnées Comment utiliser les métadonnées ?
Progression de la Leçon
0% Terminé
Vous pouvez assigner des métadonnées au contenu DITA en plusieurs endroits différents :

  • Au niveau de la rubrique
  • Au niveau de l’élément
  • Au niveau du fichier carte (un fichier carte vous permet de collecter plusieurs rubriques pour créer un document, un système d’aide, etc. ; un module ultérieur explique plus en détail les fichiers carte)

Au niveau des rubriques, DITA fournit un élément <prolog> dans lequel vous pouvez stocker des métadonnées pour l’ensemble de la rubrique. Voici un exemple de métadonnées des rubriques de base :

<topic id="xyz">
  <title>Exemple de Métadonnées</title>
  <prolog>
    <author>Sarah O’Keefe, Scriptorium</author>
    <critdates>
      <created date="2015-05-01"/>
    </critdates>
  </prolog>
  <body>
    <p>Le contenu du corps va ici</p>
  </body>
</topic>

L’auteur est spécifié dans l’élément <author>, et <critdates> fournit un emplacement pour les éléments date <created> et <revised>.

Certains éléments utiles du prologue sont :

  • <author> (l’auteur du contenu)
  • <critdates> (dates critiques telles que <created> et <revised>)
  • <copyright> (année du droit d’auteur <copyryear>, et détenteur du droit d’auteur <copyrholder>)
  • <vrm> (version du produit, release, et information de modification)

Important : Utilisez les métadonnées <prolog> uniquement pour les informations système, telles que l’auteur et les dates de création / révision. DITA n’utilise pas les métadonnées <prolog> pour filtrer les rubriques.

Au niveau élément, vous utilisez généralement des attributs dans les éléments pour spécifier les métadonnées. Voici un exemple :

<step>
    <cmd>Localiser la boîte de purée pour canard.</cmd>
    <info audience="novice">Consulter le côté de la boîte de purée de canard pour déterminer 
                la quantité de purée dont vos canards ont besoin.</info>
</step>
<step>
    <cmd>Mesurer la purée pour vos canards. </cmd>
</step>
<step>
    <cmd>Verser dans le mixeur.</cmd>
</step>
<step>
    <cmd>Mettre dans la mangeoire.</cmd>
</step> 

Seuls les novices doivent se rappeler que la boîte fournit des mesures. Lorsque vous générez votre publication, vous pouvez supprimer l’élément <info> avec les métadonnées audience= »novice » pour un public de niveau expert.

Au niveau de la carte, vous pouvez spécifier des métadonnées dans les éléments <topicref> faisant référence à des rubriques. Cela vous permet de supprimer des rubriques entières lorsque vous générez une publication. Voici un exemple :

<topicref href="abc.dita">
<topicref href="def.dita" audience="novice">
Par défaut, DITA vous fournit trois attributs prenant en charge le filtrage ou le traitement conditionnel. Ce sont :

  • audience
  • product
  • platform
Si vous avez besoin d’attributs de filtrage supplémentaires ou différents, votre architecte d’information devra recourir à la spécialisation pour définir des métadonnées supplémentaires. Certaines exigences communes sont :

  • customer, pour une information spécifique client
  • region, pour des informations qui ne s’appliquent qu’à des zones géographiques spécifiques
  • product-family, pour les informations qui s’appliquent à un groupe de produits
Contributeurs
Chapitre précédent
Retour à la Leçon
Leçon suivante