Structure des thèmes

3.1.5.1. Structure des thèmes

Tous les thèmes ont la même structure de base, indépendamment du type de thème : un titre, une description ou résumé, un prologue, un corps, des liens apparentés et des thèmes imbriqués.

Tous les thèmes DITA doivent avoir un identificateur et un titre. Les structures des thèmes comprennent les parties suivantes :

Élément de thème (<topic>)

Attribut id obligatoire ; contient tous les autres éléments.

Titre (<title>)

Le sujet du thème.

Autres titres (<titlealts>)

Les titres spécifiques utilisés pour la navigation ou la recherche. En leur absence, le titre de base est utilisé pour tous les contextes.

Description courte (<shortdesc>) ou résumé (<abstract>)

Une description courte du thème ou un résumé plus long incorporant une description courte. La description courte est utilisée à la fois dans le contenu du thème (comme premier paragraphe), dans les sommaires générés incluant le thème et dans les liens vers le thème. Autrement, le résumé permet de créer du contenu de présentation plus complexe, et il incorpore un élément de description courte pour définir la partie du résumé convenant pour les sommaires et les aperçus de lien (link previews).

Bien que non obligatoires, les descriptions courtes peuvent améliorer considérablement la convivialité d'un ensemble d'information, et elles devraient être fournies pour tous les thèmes.

Prologue (<prolog>)

Un conteneur pour divers types de métadonnées de thème, telles que l'historique des changements, le public, le produit, et ainsi de suite.

Corps (<body>)

Le contenu effectif du thème : paragraphes, listes, sections — tout ce que le type d'information permet.

Liens apparentés (<related-links>)

Les liens vers d'autres thèmes. Lorsqu'un auteur crée un lien dans le cadre d'un thème, le thème devient dépendant des autres thèmes disponibles. Pour réduire les dépendances entre les thèmes et donc améliorer la réutilisation de chaque thème, les auteurs peuvent utiliser des cartes DITA pour définir et gérer les liens entre les thèmes, au lieu d'incorporer directement les liens dans chaque thème apparenté.

Thèmes imbriqués

On peut définir des thèmes dans d'autres thèmes. L'imbrication peut aboutir à des documents complexes difficilemnt utilisables et réutilisables, et on devrait en faire un usage prudent. Elle est plus souvent appropriée pour des informations de référence, qui peuvent supporter des documents plus importants organisés en plusieurs thèmes pour la recherche (scanning) et la récupération. Les règles d'imbrication des thèmes peuvent varier d'un type de document à l'autre. Par exemple, le type de document concept permet seulement l'imbrication d'autres concepts, tandis que le type de document ditabase permet l'imbrication de tous les types de thème DITA standards.

Section parente 3.1.5. Thèmes génériques

Section suivante 3.1.5.2. Contenu des thèmes

Retour au sommaire.