Ajouter des métadonnées à une carte

Tout comme les métadonnées des rubriques vous permettent de définir des informations sur celles-ci, les métadonnées des cartes vous permettent de définir des informations sur une carte DITA et les références contenues dans celle-ci.

Vous ajoutez des métadonnées à une carte DITA en utilisant l’élément <topicmeta>. L’élément <topicmeta> peut exister au niveau de la carte principale (à l’intérieur de l’élément <map>) ou à l’intérieur de n’importe quel élément <topicref> ou <mapref> de la carte.

Lorsqu’elles sont utilisées au niveau de la carte, les métadonnées carte ajoutent des informations à une carte et facilitent la recherche et le filtrage. Dans la plupart des cas, les métadonnées carte n’apparaissent pas dans le résultat final publié, mais elles peuvent influencer la manière dont votre contenu est publié, par exemple en spécifiant comment une transformation doit générer des informations sur la couverture.

Lorsqu’elles sont appliquées aux éléments <topicref> ou <mapref>, les métadonnées carte fournissent des informations supplémentaires sur les rubriques ou les cartes référencés et peuvent même remplacer les métadonnées contenues dans ces rubriques et cartes. Par exemple, si une rubrique référencée contient un élément <prolog> ou <shortdesc>, les métadonnées d’un élément <topicref> qui contient des éléments <prolog> ou <shortdesc> ont la priorité.

Un certain nombre d’éléments de métadonnées sont autorisés à l’intérieur de l’élément <topicmeta>. Parmi les plus utiles, on peut citer :

  • <navtitle>

  • <author>

  • <copyright>

  • <category>

L’élément <metadata>, qui peut également contenir la plupart de ces mêmes éléments liés aux métadonnées, est également autorisé à l’intérieur de l’élément <topicmeta>.

La structure d’un élément de type <topicmeta> pourrait ressembler à ceci :

<topicmeta>
<navtitle>Titre de navigation</navtitle>
<author>Nom de l'auteur</author>
<copyright>
     <copyryear year="20XX"/>
     <copyrholder>Nom de la compagnie</copyrholder>
</copyright>
<category>Nom de la catégorie</category>
</topicmeta>

Remarque :

Pour plus d’information sur l’élément <topicmeta> et les éléments qu’il contient, se référer à la norme OASIS DITA version 1.2.

Pratique
  1. Faites une copie du fichier exemples_cartes_bookmaps/exemples/_m_canards_avances_debut.ditamap et ouvrez-le dans votre éditeur.

    Vous devriez voir du contenu qui commence comme ceci (le fichier est plus long que ce qui est présenté ici) :

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
    <map id="canards">
        <title>Canards</title>
        <topicref href="c_canards_sauvages.dita">
            <topicref href="c_types_canards_sauvages.dita"/>
            <topicref href="c_especes_canards_sauvages.dita"/>
            <topicref href="c_habitats.dita"/>
            <topicref href="t_observer_canards_sauvages.dita"/>
        </topicref>
            <topicref href="c_canards_domestiques.dita">
            <topicref href="c_croissance_des_canards.dita"/>
            <topicref href="c_logement.dita"/>
            ...

  2. À l’intérieur de l’élément <map>, après l’élément <title>, ajoutez un élément <topicmeta> et ajoutez-y du contenu comme le montre l’exemple suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
    <map id="canards">
    <title>Canards</title>
    <topicmeta>
        <critdates>
          <created date="2016-03-16"/>
          <category>Exemples</category>
        </critdates>
      </topicmeta>
    ...
    </map>

    L’élément <topicmeta> que vous venez d’ajouter établit les métadonnées suivantes au niveau de la carte :

    • La carte a été créée le 16 mars 2016

    • C’est une carte d’exemple

  3. À l’intérieur de l’élément <topicref> qui fait le lien vers c_canarddb.dita, ajouter un élément <topicmeta> et ajoutez-y du contenu comme le montre l’exemple suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
    <map id="canards">
    <title>Canards</title>
    ...
    <topicref href="c_canarddb.dita">
    <topicmeta>
    <audience type="user" experiencelevel="expert"/>
    </topicmeta>
    <topicref href="c_ecrire_sur_canards.dita"/>
    ...
    </topicref>
    ...
    </map>

    L’élément <topicmeta> que vous venez d’ajouter établit les métadonnées suivantes au niveau de la carte :

    • Cette section est destinée aux utilisateurs du produit, par opposition aux administrateurs ou aux lecteurs occasionnels.

    • Cette section est destinée aux utilisateurs experts

  4. À l’intérieur de l’élément <mapref> qui fait le lien vers g_orggloss_canards.ditamap, ajoutez un élément <topicmeta> et ajoutez-y du contenu comme le montre l’exemple suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
    <map id="canards">
    <title>Canards</title>
    ...
    <mapref href="g_orggloss_canards.ditamap" format="ditamap">
    <topicmeta>
    <searchtitle>Glossaire canards</searchtitle>
    </topicmeta>
    </mapref>
    </map>

    L’élément <topicmeta> que vous venez d’ajouter établit les métadonnées suivantes au niveau de la carte :

    • Lorsqu’une personne utilise un outil de recherche et localise cette rubrique, le titre doit être « Glossaire canards » au lieu du titre de la rubrique.

  5. Utilisez le fichier d’exemple exemples_cartes_bookmaps/exemples/_m_canards_avances.ditamap pour vérifier votre fichier exemples_cartes_bookmaps/exemples/_m_canards_avances_debut.ditamap.
Contributeurs