Voici quelques éléments avancés communs dans DITA :
|
<codeblock>
|
Élément contenant un morceau de code. En général, le rendu est dans une police monospace dans les publications PDF ou HTML. Le placement du contenu dans l’élément <codeblock> vous permet de contrôler les sauts de ligne.
|
|
<codeph> (code phrase)
|
Élément affichant comme du code un seul mot ou une seule phrase à l’intérieur d’un élément de type <p>. Par exemple, si vous mentionnez un élément dans un paragraphe et que vous souhaitez afficher uniquement le nom de cet élément dans une police monospace, l’élément <codeph> est utile.
|
|
<lq> (long quote)
|
Élément permettant d’inclure une citation d’une source externe dans votre contenu plutôt que (ou en plus) d’établir un lien vers la source.
|
Pratique
- Faites une copie du fichier leçon4/l_concept_avance_debut.dita et ouvrez-le dans votre éditeur.
Remarque :
Si vous utilisez un éditeur de texte compatible 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 concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
</conbody>
</concept>
- À l’intérieur de l’élément <conbody>, ajoutez un élément <codeblock> et ajoutez-y du contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
<codeblock>
donneescanard> add entry (mallard)
;
1 entrée ajoutée (0.05 sec)
donneescanard> _
</codeblock>
</conbody>
</concept>
L’élément <codeblock> isole le contenu du code de sorte que les balises qu’il contient n’existent que pour l’affichage et n’affectent pas les balises DITA dans votre fichier concept.
L’élément <codeblock> permet également de contrôler les sauts de ligne. Dans l’exemple que vous avez ajouté, le texte à l’intérieur de l’élément <codeblock> montre une entrée ajoutée à une base de données à l’aide de la ligne de commande.
Remarque :
Si vous avez besoin d’une balise d’ouverture dans un élément de type <codeblock>, tapez < à la place du caractère de la balise d’ouverture (<). Si vous travaillez en mode auteur ou visuel d’un éditeur DITA, vous pouvez taper le caractère de la balise d’ouverture dans un élément <codeblock>, et l’élément <codeblock> le rendra automatiquement sous la forme < dans le texte.
- Après l’élément <codeblock>, ajoutez un élément <p> avec un élément <codeph> à l’intérieur et ajoutez-y du contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
</codeblock>
<p>Pour ajouter une espèce de canard à votre base de données, tapez <codeph>add entry</codeph> suivi
du nom du canard entre parenthèses sur la ligne de commande et appuyez sur Entrée.</p>
</conbody>
</concept>
Dans l’exemple que vous avez ajouté, l’élément <codeph> vous permet d’isoler les mots « add entry » et d’indiquer qu’ils doivent être affichés dans une police monospace pour montrer qu’il s’agit d’une commande.
- Après l’élément <p>, ajoutez un élément <lq> et ajoutez-y du contenu tel que présenté dans l’exemple suivant :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_avance">
<title>Écrire sur les canards</title>
<conbody>
...
</p>
<lq href="http://classiclit.about.com/library/bl-etexts/hdthoreau/bl-hdtho-wald-9.htm"
format="html" scope="external">How much fairer than the pool before the farmers door,
in which his ducks swim! Hither the clean wild ducks come. Nature has no human
inhabitant who appreciates her. The birds with their plumage and their notes are in
harmony with the flowers, but what youth or maiden conspires with the wild luxuriant
beauty of Nature?</lq>
</conbody>
</concept>
Dans l’exemple que vous avez ajouté, l’élément <lq> vous permet d’inclure une citation de Walden de Henry David Thoreau.
L’élément <lq> peut contenir un lien vers la source de la citation. Dans l’exemple que vous avez ajouté, l’élément <lq> contient un attribut href pointant vers l’URL de la source, un attribut format indiquant que la source est HTML, et un attribut scope indiquant que la source est externe.
Contributeurs
