19.10. topicref

L'élément <topicref> identifie un thème (tel qu'un concept, une tâche ou une référence) ou une autre ressource. Un élément <topicref> peut contenir d'autres éléments <topicref>, ce qui permet d'exprimer des hiérarchies de navigation ou de table des matières, ainsi que d'impliquer des relations entre l'élément <topicref> et ses sous-éléments. On peut fixer la valeur de l'attribut collection-type du <topicref> conteneur pour déterminer comment ses sous-éléments sont liés les uns aux autres. On peut aussi exprimer des relations entre les éléments <topicref> en utilisant des structures de groupe et de table (avec les éléments <topicgroup> et <reltable>). Les relations s'expriment comme des liens en sortie (chaque membre de la relation ayant par défaut des liens vers les autres membres).

On peut affiner la sortie d'une carte en définissant différents attributs sur les éléments <topicref> : par exemple, l'attribut linking contrôle comment ses relations aux autres éléments <topicref> s'expriment en liens, et l'attribut toc contrôle si l'élément <topicref> apparaît dans une sortie de table des matières ou de navigation.

Exemple

Dans cet exemple, il y a six éléments <topicref>. Ils sont imbriqués et ont une relation hiérarchique. Le fichier bats.dita est le thème parent et les autres thèmes sont ses enfants.

<map title="Bats">
 <topicref href="bats.dita" type="topic">
  <topicref href="batcaring.dita" type="task"></topicref>
  <topicref href="batfeeding.dita" type="task"></topicref>
  <topicref href="batsonar.dita" type="concept"></topicref>
  <topicref href="batguano.dita" type="reference"></topicref>
  <topicref href="bathistory.dita" type="reference"></topicref>
 </topicref>
</map>

Contient :

Doctype Modèle de contenu
map ( ( topicmeta) (optionnel) puis ( topicref ou topichead ou topicgroup ou navref ou anchor ou data ou data-about) (un nombre quelconque) )
bookmap ( ( topicmeta) (optionnel) puis ( topicref ou topichead ou topicgroup ou navref ou anchor ou data ou data-about) (un nombre quelconque) )

Contenu par :

Doctype Parents
bookmap map, topicref, relcell, frontmatter, backmatter, draftintro, preface, chapter, part, appendix, notices, glossarylist, topichead, topicgroup
map map, topicref, relcell, topichead, topicgroup

Héritage :

- map/topicref

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
navtitle Spécifie le titre du thème tel qu'il apparaîtra dans la navigation ou les tables des matières générées à partir de la carte. CDATA #IMPLIED non
href Un pointeur vers la ressource représentée par l'élément <topicref>. Les références au contenu DITA ne peuvent pas descendre sous le niveau thème : c'est-à-dire que l'on ne peut pas référencer des éléments individuels dans un thème. Les références à un autre contenu que des thèmes DITA devrait utiliser l'attribut format pour identifier le type de ressource qui est référencé. CDATA #IMPLIED non
query Cet attribut est déconseillé. Il sera peut-être supprimé dans le futur. CDATA #IMPLIED non
copy-to Utilisez l'attribut copy-to sur l'élément <topicref> pour fournir un nom de fichier différent pour une instance particulière du thème dans la carte (par exemple, pour distinguer les différentes versions du thème plutôt que de les combiner à la sortie). Les liens et la navigation associés à cette instance pointeront vers une copie du thème avec le nom de fichier spécifié.

Utilisez les éléments <linktext> et <shortdesc> dans l'élément <topicmeta> du <topicref> pour fournir un nom unique et une description courte pour la nouvelle copie.

CDATA #IMPLIED non
%topicref-atts; (collection-type, type, scope, locktitle, format, linking, toc, print, search, chunk) Un ensemble d'attributs liés. Cf. la section 25.8. %topicref-atts; et %topicref-atts-no-toc;. entité paramètre sans objet pour une entité paramètre sans objet
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) Un ensemble d'attributs liés, décrit à la section 25.7. %univ-atts; entité paramètre sans objet pour une entité paramètre sans objet
%global-atts; (xtrf, xtrc) Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts; entité paramètre sans objet pour une entité paramètre sans objet
class, outputclass, keyref Attributs communs, décrit à la section 25.9. Autres attributs DITA communs