En plus du traitement conditionnel, vous pouvez utiliser le traitement conditionnel pour marquer un contenu prévu pour un public précis ou pour un produit particulier. Vous pouvez marquer un élément à l’aide de n’importe quel attribut conditionnel. Vous pouvez aussi utiliser l’attribut rev pour marquer et indiquer le numéro de révision précis du produit ou du service.
Note: Les exemples suivants sont consultables dans le dossier d’exemples exemples_reutilisation_avance.zip. Les fichiers montrés dans cette leçon sont c_marquer_et_filtrer.dita, sauvage.ditaval et afficher_rev.ditaval
Marquer les attributs conditionnels
Pour utiliser les attributs conditionnels pour marquer le contenu, utilisez l’élément <prop> associé à l’attribut et sa valeur action= »flag » dans votre fichier ditaval. Vous pourez marquer le contenu à l’aide d’une couleur de police ou du fond différente du reste, changer le style du texte ou encore changer les illustrations (les options disponibles varient en fonction du générateur de publication). Par exemple :
<prop att="platform" val="android" action="flag" color="purple"/>
L’élement <prop> de cet exemple indique au transformateur de changer la couleur du text en violet pour chaque élément contenant l’attribut platform et la valeur « android ».
<prop> accueille les attributs de marquage suivant :
- color : change la couleur du texte en fonction de la valeur de l’attribut
- background : surligne le texte en fonction de la valeur de l’attribut
- style : formatte le texte dans un autre style en fonction de la valeur de l’attribut :
Anglais Français italics italique bold gras underline souligné double-underline souligné double overline trait suscrit Il convient d’entrer une valeur en anglais pour obtenir le résultat escompté.
| Anglais | Français |
|---|---|
| aqua | turquoise |
| black | noir |
| blue | bleu |
| fuchsia | fuchsia |
| gray | gris |
| green | vert |
| lime | vert citron |
| maroon | bordeaux |
| navy | bleu marine |
| olive | jaune olive |
| purple | violet |
| red | rouge |
| silver | argent |
| teal | sarcelle |
| white | blanc |
| yellow | jaune |
Comme pour l’attribut style, il convient d’entrer une valeur en anglais pour obtenir le résultat escompté.
Par exemple, si nous réutilisons l’exemple de la leçon précédente :
<p>Pour avoir des canards en bonne santé, nous vous recommandons de les nourrir avec nos aliments.</p> <p>Toute notre gamme d'alimentation pour canard est composée de maïs fendillé, d'avoine, de riz et de graînes de sorgho. <ph product="canards_sauvages">Notre gamme d'alimentation pour canard sauvage inclut des vers et du poisson.</ph> </p> <p>Tous nos produits sont disponibles sous forme de sac de 5, 10 et 20 kilogrammes.</p>
Avec ce fichier ditaval :
<val> <prop action="flag" att="product" val="canards_sauvages" color="red" style="underline"/> </val>
Nous obtiendrons ce résultat :
Vous pouvez aussi spécifier l’ajout d’une image à placer ou après l’élément marqué avec les éléments <startflag> et <endflag>. L’élement <prop action= »flag »> est le parent de ces deux éléments. L’attribut imageref indique le chemin vers l’image à utiliser.
<prop att="platform" val="android" action="flag"> <startflag imageref="images/android_icon.png"> <alt-text>icone android</alt-text> </startflag> </prop>
Les éléments <startflag> et <endflag> peuvent contenir <alt-text> qui précise un texte alternatif à l’image.
L’attribut rev
L’attribut rev sert à indiquer et à marquer une version spécifique de votre produit ou service. Cet attribut est utilisable de la même façon que tous les autres attributs conditionnels et avec presque tous les éléments de DITA :
<p rev="v2.1">Veuillez considérer le recours aux tableaux personalisés pour tout besoin supplémentaire.</p>
La valeur donnée à l’attribut rev dépend de vous de votre équipe. Le plus important est de rester cohérent dans les valeurs que vous donnez.
Tout comme les autres attributs conditionnels, vous pouvez donner plusieurs valeurs à l’attribut rev en les séparant d’un ou plusieurs espaces.
<p rev="v2.7 v2.8">Ce champs est limité à 32 caractères.</p>
Note: Souvenez-vous que l’attribut rev ne sert pas à filtrer le contenu : il ne sert seulement qu’à le marquer.
Montrer le contenu marqué par l’attribut rev
Vous pouvez contrôler l’affichage du contenu marqué l’attribut rev grâce à l’élément <revprop> dans un fichier ditaval. Vous pouvez changer le style de l’élément visé avec les mêmes outils que l’élément <prop> (couleur, surlignage, style). Les éléments <startflag> et <endflag> sont disponibles pour afficher une image avant ou après le contenu marqué par l’attribut rev.
Par exemple, si une rubrique DITA accueille ce contenu :
<p>La base de données canard vous aidera à satisfaire la plupart des besoins de vos canard.</p> <p rev="2.1"> Si vous avez des besoins spécifiques, veuillez considérer utiliser la création de tableaux personalisés.</p> <p> Pour plus d'informations sur les tables standards, veuillez consulter l'annexe C.</p>
Vous pouvez générer une publication associée à ce fichier ditaval :
<val> <revprop action="flag" val="2.1" backcolor="aqua"/> </val>
Nous obtiendrons ce résultat :
En fonction du format de votre publication et de votre transformateur, vous pouvez utiliser l’élement <revprop> pour ajouter des marques de révision (changebar) à côté du contenu marqué par l’attribut rev. Cependant, les options de personnalisations et de syntaxes offertes par l’attribut changebar dépend du format de la publication et du transformateur. Si vous avez besoin de cette fonctionnalité, veuillez consulter la documentation de votre transformateur.
Pour plus d’informations sur les fichiers ditaval et comment les utiliser pour le traitement conditionnel, veuillez consulter le lien suivant (en anglais) http://docs.oasis-open.org/dita/v1.2/os/spec/common/about-ditaval.html#ditaval
Contributors
- Simon Bate
- Jake Campbell
- Gretyl Kinsey
- Decarnelle Rémi (traducteur)