Au minimum, la référence doit contenir un élément racine <reference> (avec un attribut id) qui contient un élément <title>.
À la suite de l’élément <title> et d’un élément optionel <shortdesc>, un élément <refbody> contient le contenu de référence. De par sa conception, le contenu de l’élément <refbody> est limité à une poignée d’éléments. En d’autres termes, une référence n’est pas aussi flexible dans son contenu qu’un concept.
Le corps d’une référence peut contenir des éléments qui ont été introduits dans les cours précédents : <table>, <fig> (figure) ou <image>, <exemple> et <section>. Vous utilisez habituellement l’élément <section> dans un élément <refbody> pour organiser les sections communes d’une référence, telles que les descriptions de commande, les directives d’utilisation, les codes d’erreur, etc. En outre, l’élément <refbody> peut contenir deux éléments spécifiques aux références : <refsyn> (syntaxe de référence) et <properties>.
Le corps d’une référence peut contenir un nombre quelconque de ces éléments, dans n’importe quel ordre.
Les éléments <example>, <section> et <refsyn> peuvent contenir l’élément <title>. Cela vous permet de créer des subdivisions au sein d’une rubrique référence. Si nécessaire, une transformation en vue d’une publication peut insérer ses propres titres pour les éléments <properties>.
Vidéo : Créer une référence DITA
Pratique
- Faites une copie du fichier l_reference_debut.dita et ouvrez-le dans votre éditeur.
Remarque : Si vous utilisez un éditeur DITA, assurez-vous que vous êtes en mode texte, plutôt qu’en mode auteur ou visuel.
Vous devriez voir ceci :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="ma_premiere_ref">
<title></title>
</reference>
La première ligne (qui commence avec <?xml>) est une déclaration XML et est une partie standard à tous fichiers XML.
La deuxième ligne est une déclaration DOCTYPE indiquant aux éditeurs DITA ou aux générateurs de publication DITA qu’il s’agit d’une référence DITA. Le programme utilise alors cette information lors de la validation du contenu de la rubrique. Le DOCTYPE sera différent pour chaque type de rubrique que vous créez.
La troisième ligne contient la balise d’ouverture de l’élément <reference>.
La quatrième ligne contient l’élément <title>.
- À l’intérieur de l’élément <title>, modifiez le texte du titre de la référence.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="ma_premiere_ref">
<title>tNav</title>
</reference>
- Après l’élément <title>, ajoutez un élément <refbody>.
L’élément <refbody> contient tout le contenu courant de la référence.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="ma_premiere_ref">
<title>tNav</title>
<refbody>
</refbody>
</reference>
- À l’intérieur de l’élément <refbody>, ajoutez un élément <section> et ajoutez-y du contenu tel que présenté ici :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="ma_premiere_ref">
<title>tNav</title>
<refbody>
<section><p>La commande <cmdname>tNav</cmdname> est utilisée dans la
base de données Canard pour naviguer vers une table ou une vue différente.</p></section>
</refbody>
</reference>
Remarque :
L’élément <cmdname> (nom de commande) désigne le nom d’une commande lorsqu’elle est référencée comme faisant partie d’un logiciel, et fait partie du domaine de programmation. Pour plus d’informations sur le domaine de programmation, se référer à la Norme OASIS DITA version 1.2.
Contributeurs
