Les éléments frontmatter, backmatter et booklists

Les éléments <frontmatter> et <backmatter> sont optionnels dans une bookmap. Ils contiennent des informations sur le document qui apparaissent respectivement avant ou après le contenu principal. L’élément <frontmatter> doit apparaître juste avant le premier élément <chapter>, mais après l’élément <bookmeta>, s’il est présent. L’élément <backmatter> doit apparaître avant l’élément <reltable> mais après le dernier élément <chapter> ou <appendix>, s’il est présent.

Les éléments <frontmatter> et <backmatter> sont le plus souvent utilisés pour contenir l’élément <booklist>. Cet élément indique au processeur DITA où placer, dans les documents de sortie, les parties générées automatiquement tel qu’une table des matières ou un index. Les éléments communs à l’intérieur de l’élément <booklists> incluent :

  • <toc>

  • <indexlist>

  • <glossarylist>

L’élément <toc> indique au processeur DITA de générer une table des matières à cet endroit de la carte. La table des matières est générée à partir de la structure hiérarchique de la carte. Aucune information supplémentaire n’est requise.

L’élément <indexlist> indique au processeur DITA de générer un index à cet endroit de la carte. L’index est généré à partir des éléments <indeterm> présents dans la carte et dans les rubriques. S’il n’y a aucun élément <indexterm> dans la carte ou dans les rubriques, aucune entrée d’index ne sera créée.

L’élément <glossarylist> peut contenir un ou plusieurs éléments <topicref> pointant vers les entrées de glossaire ou un ou plusieurs éléments <mapref> pointant vers les cartes de glossaire. Les entrées de glossaire et les cartes de glossaire peuvent être utilisées en dehors de l’élément <glossarylist>, mais les groupes dans un élément <glossarylist> vous permet de les filtrer et de les mettre en forme de manière plus uniforme.

Remarque :

Pour plus d’information sur les éléments <frontmatter> et <backmatter>, se référer aux chapitres frontmatter et backmatter dans la norme OASIS DITA version 1.2.

Vidéo : Les éléments booklist DITA

Pratique
  1. Continuez d’utiliser le fichier exemples_cartes_bookmaps/exemples/_b_canards_avances_debut.ditamap.
  2. Après l’élément <bookmeta>, ajouter un élément <frontmatter> et ajoutez-y du contenu comme le montre l’exemple suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
    <bookmap id="canards">
    ...
    </bookmeta>
    <frontmatter>
        <booklists>
            <toc/>
        </booklists>
    </frontmatter>

  3. Après le dernier élément <chapter>, ajoutez un élément <backmatter> et ajoutez-y du contenu comme le montre l’exemple suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
    <bookmap id="canards">
    ...
    </chapter>
    
    <backmatter>
        <booklists>
            <glossarylist>
                <topicref href="g_groupegloss_canards.dita"/>
            </glossarylist>
            <indexlist/>
        </booklists>
    </backmatter>

    L’élément <glossarylist> indique que le glossaire provient d’un fichier spécifique. L’élément <indexlist> indique que le processeur DITA devra générer un index à partir des rubriques de la carte.

Contributeurs