L’élément <topicref> est structurée comme suit :
<topicref href="chemin/nomfichier.dita">
L’attribut href contient un lien vers la rubrique à inclure dans la carte. Avec DITA, un élément <topicref> dans une carte ne devrait pas pointer vers une rubrique situé au-dessus de la carte dans votre structure de fichiers, car cela peut causer des problèmes avec certains types de sortie. Par conséquent, il est préférable de stocker vos cartes au niveau supérieur.
L’élément <topicref> peut contenir les éléments suivants :
-
L’élément <topicmeta>, qui définit les métadonnées de la rubrique référencée.
-
Un certain nombre d’éléments <topicref>.
-
Un certain nombre d’éléments <mapref>.
En imbriquant des éléments <topicref> ou <mapref> à l’intérieur d’un élément <topicref>, vous pouvez créer une hiérarchie dans votre carte. Cela vous permet d’organiser plus facilement vos rubriques. Vous pouvez refléter la hiérarchie des rubriques dans une table des matières lorsque vous publiez la carte.
Lorsque vous imbriquez des éléments <topicref>, il est important de garder en tête le résultat final. Avec DITA, il n’y a pas de limite structurelle au nombre d’éléments <topicref> qui peuvent être imbriqués ; tout élément <topicref> dans une carte peut contenir un certain nombre d’éléments <topicref>. Cependant, chaque élément <topicref> imbriqué équivaudra généralement à un nouveau niveau de titre dans votre publication. Par conséquent, il est généralement considéré comme une bonne pratique d’éviter d’imbriquer des éléments <topicref> sur plus de cinq niveaux de profondeur (et, idéalement, pas plus de deux ou trois).
Vidéo : Créer une carte DITA
Remarque :
Pour plus d’information sur l’élément <topicref>, se référer à la norme OASIS DITA version 1.2.
Pratique
- Continuez d’utiliser le fichier exemples_cartes_bookmaps/exemples/_m_canards_demarrer.ditamap.
- Après l’élément <title>, ajoutez un élément <topicref> 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_canards_sauvages.dita">
</topicref>
</map>
Cet élément <topicref> crée un lien vers le concept c_canards_sauvages.dita.
- À l’intérieur de l’élément <topicref> que vous venez d’ajouter, ajoutez un autre élément <topicref> 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_canards_sauvages.dita">
<topicref href="c_types_canards_sauvages.dita"/>
</topicref>
</map>
En plaçant cet élément <topicref> à l’intérieur du premier, vous avez imbriqué la rubrique c_types_canards_sauvages.dita au niveau suivant sous c_canards_sauvages.dita dans la hiérarchie de votre carte.
- Après l’élément <topicref> que vous venez d’ajouter, ajoutez deux autres éléments <topicref> 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_canards_sauvages.dita">
<topicref href="c_types_canards_sauvages.dita"/>
<topicref href="c_especes_canards_sauvages.dita"/>
<topicref href="t_observer_canards_sauvages.dita"/>
</topicref>
</map>
Ces nouveaux éléments <topicref> rendent la hiérarchie dans votre carte DITA encore plus claire. Les rubriques c_types_canards_sauvages.dita, c_especes_canards_sauvages.dita et t_observer_canards_sauvages.dita concernent tous les canards sauvages et sont donc regroupées sous la rubrique c_canards_sauvages.dita.
- Après la balise de fermeture de l’élément <topicref> de c_canards_sauvages.dita, ajoutez d’autres éléments <topicref> 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_canards_sauvages.dita">
<topicref href="c_types_canards_sauvages.dita"/>
<topicref href="c_especes_canards_sauvages.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_nourrir_canetons.dita">
<topicref href="c_poids_du_canard.dita"/>
</topicref>
</topicref>
<topicref href="c_canarddb.dita">
<topicref href="c_ecrire_sur_canards.dita" locktitle="yes"/>
<topicref href="r_tnav.dita"/>
</topicref>
</map>
La hiérarchie de la carte contient désormais trois éléments de premier niveau : c_canards_sauvages.dita, c_canards_domestiques.dita et c_canarddb.dita. Chacun de ces éléments contient plusieurs éléments <topicref> imbriqués de second niveau. L’un de ces éléments <topicref> de deuxième niveau, c_nourrir_canetons.dita, contient un élément <topicref> imbriqué de troisième niveau element, c_poids_du_canard.dita.
Contributeurs
