Éléments de thème

2. Éléments de thème

Utilisez la structure de thème générique pour des thèmes non typés. Bien que la majeure partie de l'architecture DITA soit bâtie sur des thèmes génériques, il est généralement préférable d'employer les types d'information plus spécifiques (tels que concept, task ou reference) lorsque c'est possible. Pour une réponse à la question « Les thèmes qu'est-ce que c'est ? » et plus de détails sur quand employer des types d'information différents, veuillez consulter la spécification architecturale DITA.

2.1. topic
L'élément <topic> est l'élément DITA de niveau supérieur d'un thème ou d'un article à sujet unique. D'autres éléments DITA de niveau supérieur ont un contenu plus spécifique : <concept>, <task>, <reference> et <glossary>.

2.2. title
L'élément <title> contient un titre ou un intitulé des parties principales d'un thème, à savoir le thème dans son ensemble, ses sections et exemples, et son contenu légendé, tel que les figures et les tableaux. À partir de DITA 1.1, l'élément peut aussi servir à fournir un titre pour une carte.

2.3. titlealts
L'élément de titre alternatif (<titlealts>) est optionnel mais peut apparaître après le titre du thème. L'élément <titlealts> peut recevoir deux sous-éléments : un titre de navigation <navtitle> et un titre de recherche <searchtitle>.

2.4. navtitle
L'élément de titre de navigation (<navtitle>) fait partie d'un ensemble de titres alternatifs que l'on peut inclure dans l'élément <titlealts>. Ce titre de navigation peut différer du titre de premier niveau qui apparaît dans la fenêtre principale du navigateur. Utilisez <navtitle> quand l'emploi du titre réel du thème n'est pas approprié dans les fenêtres de navigation annexes ou dans les contenus en ligne (par exemple, parce que le titre réel est trop long).

2.5. searchtitle
Lorsque le thème DITA est transformé en XHTML, l'élément <searchtitle> est utilisé pour créer un élément de titre en haut du fichier HTML produit. Ce titre est normalement utilisé dans les synthèses de résultats de recherche par certains moteurs de recherche, tels que celui dans Eclipse (http://eclipse.org) ; s'il n'est pas fixé, l'élément de titre du document XHTML prend alors le contenu du titre du thème source (qui conviendra peut-être moins bien aux synthèses de recherche).

2.6. abstract
L'élément <abstract> se place entre le titre et le corps du thème, comme contenu initial d'un thème. Il peut avoir un contenu de paragraphes ainsi qu'un ou plusieurs éléments <shortdesc> utilisables pour fournir des aperçus ou des résumés de lien. L'élément <abstract> ne peut pas être modifié par les cartes mais son contenu d'éléments <shortdesc> peut l'être dans le but de créer des résumés ou des aperçus de lien.

2.7. shortdesc
L'élément de description courte (<shortdesc>) apparaît entre le titre et le corps du thème, comme contenu de type paragraphe initial d'un thème, ou il peut être incorporé dans un élément <abstract>. La description courte, qui représente le but ou le sujet du thème, sert également d'aperçu de lien et pour la recherche. Utilisée dans une carte DITA, la description courte de l'élément <topicref> peut servir à remplacer la description courte dans le thème.

2.8. body
L'élément <body> est le réceptacle du contenu principal d'un élément <topic>.

2.9. section
L'élément <section> représente une division organisationnelle dans un thème. Les sections sont utilisées pour organiser des sous-ensembles d'information qui sont directement liés au thème. Par exemple, les titres « Syntaxe de référence », « Exemple » et « Propriétés » pourraient représenter un discours de niveau section dans un thème à propos d'un processus en ligne de commande — le contenu de chaque section étant exclusivement lié au sujet de ce thème. Plusieurs sections dans un seul thème ne représentent pas une hiérarchie mais plutôt des divisions sœurs de ce thème. Les sections ne peuvent pas s'imbriquer. Une section peut avoir un titre optionnel.

2.10. example
L'élément <example> est une section dont le rôle spécifique est de contenir les exemples qui illustrent ou appuient le thème courant. L'élément <example> a le même modèle de contenu que l'élément <section>.

2.11. related-links
Les liens d'informations apparentées d'un thème (<related-links>) sont stockés dans une section spéciale à la suite du corps du thème. Après le traitement d'un thème vers sa forme de sortie finale, les liens apparentés sont affichés habituellement à la fin du thème, quoique certains systèmes d'aide fondés sur le Web puissent les afficher dans un cadre de navigation séparé.

Section précédente 1. Introduction

Section suivante 2. Éléments de concept

Retour au sommaire.