Cela s’applique à d’autres types de rubriques, mais il convient de le mentionner pour les références du fait qu’elles sont souvent associées à des éléments de programmation et d’interface utilisateur.
DITA définit un certain nombre d’éléments utiles pour les rubriques décrivant la programmation, les logiciels informatiques et les interfaces utilisateur des ordinateurs. Ces éléments sont appelés spécialisations de domaine, car, bien qu’il s’agisse de spécialisations d’éléments existants, ils peuvent être utilisés dans toutes les spécialisations de rubrique, telles que les concepts, tâches et références.
Il est conseillé d’utiliser ces éléments sémantiques car ils :
-
Fournissent des informations sur leur contenu aux autres auteurs
-
Aident à la recherche multidimensionnelle (« Trouver tous les noms de fichiers qui utilisent le nom de produit X »)
-
Peuvent diriger l’outil de publication pour formater le contenu afin de le rendre plus facilement visible pour les lecteurs
Certains des éléments qui peuvent être utiles sont :
- Domaine de programmation
- <apiname>, <codeblock>, <codeph> (phrase de code), <option>, <parml> (liste de paramètres), <synph> (phrase de syntaxe)
- Domaine des logiciels
- <cmdname> (nom de commande), <filepath>, <varname> (nom de variable), <userinput>, <systemoutput>
- Interfaces utilisateur des ordinateurs
- <uicontrol> (contrôle de l’interface utilisateur), <menucascade>, <wintitle> (titre fenêtre), <screen>
Deux des éléments de l’interface utilisateur de l’ordinateur méritent une attention particulière : <uicontrol> et <menucascade>. Vous utilisez <uicontrol> pour décrire un bouton ou une commande dans un menu. Si vous voulez décrire la séquence à suivre pour accéder à une commande, utilisez une série d’éléments de type <uicontrol> à l’intérieur d’un élément <menucascade> :
...en choisissant <menucascade><uicontrol>Fichier</uicontrol><uicontrol>Ouvrir</uicontrol></menucascade>.
Une transformation insère tout caractère approprié entre les commandes. Cela permet de s’assurer que toutes les cascades de menus sont formatées de la même manière, en utilisant le même caractère de séparation :
...en choisissant Fichier » Ouvrir
Pour plus d’informations sur tous les éléments du domaine, voir la spécification DITA.
Nous vous conseillons également vivement de créer un guide de style dans lequel vous documentez les utilisations spécifiques de chacun de ces éléments dans votre documentation produit.