Les exemples: <exemple>

L'insertion d'un exemple, comme ceux montrés tout au long de ce document, se fait à l'aide d'un élément <exemple>.

Les données qu'il contient seront affichées en respectant la mise en page (indentation du texte, passages à la ligne...), tout en utilisant une police de caractères non proportionnelle.

Par exemple, ce code-ci:

<exemple>
if (outputOk)
   {
   for (int i=0; i&lt;data.size(); i++)
       {
       if (i>0) System.out.print(", ");
       System.out.print((String)data.get(i));
       }
   System.out.println();    
   }   
</exemple>

affichera le résultat suivant:

if (outputOk)
   {
   for (int i=0; i<data.size(); i++)
       {
       if (i>0) System.out.print(", ");
       System.out.print((String)data.get(i));
       }
   System.out.println();    
   }   
			

Encodage des caractères spéciaux

Remarquez que dans l'exemple ci-dessus, pour afficher le caractère <, il a fallu l'encoder par &lt;. En effet, le caractère < ne peut jamais s'écrire directement en xml. Il en va de même pour le caractère & qui doit être encodé par &amp; (voir introduction au langage xml).

Si on veut utiliser des caractères < ou & librement sans devoir les encoder, on peut utiliser une zone CDATA prévue dans le langage XML. Elle commence par <![CDATA[ et se termine par ]]>.

Cet exemple ci-dessous donnera le même résultat que celui ci-dessus:

<exemple><![CDATA[[
if (outputOk)
   {
   for (int i=0; i<data.size(); i++)
       {
       if (i>0) System.out.print(", ");
       System.out.print((String)data.get(i));
       }
   System.out.println();    
   }   
]]>
</exemple>

Titre de l'exemple

Par défaut, l'exemple est affiché avec un titre égal à "Exemple" (ou "Example" dans des pages écrites en anglais).

On peut également choisir un autre titre, grâce à un attribut titre, comme le montre cet exemple:

<exemple titre="Titre de mon exemple">
   <p>Voici le texte de cet exemple</p>
</exemple>

Et si on ne veut pas de titre, on met titre="":

<exemple titre="">
   <p>Voici le texte de cet exemple</p>
</exemple>

Style des exemples

Un exemple s'affiche comme un <bloc>, avec ou sans mise en page particulière, au même titre que tous les autres blocs. Le contrôle de cette mise en page se fait comme dans les <bloc> grâce à un attribut style (voir toutes les informations sur cet attribut dans les blocs).

La différence, c'est qu'un exemple utilisera par défaut un style égal "clair-cadre1+titre", tandis qu'un bloc sans attribut style n'utilisera pas de style par défaut.

Comme dans un bloc, vous pouvez également choisir entre des coins carrés ou arrondis grâce à l'attribut bords et toutes ses variantes (voir toutes les informations sur ces attributs dans les blocs).

<exemple titre="Changement de style" style="voile-cadre" bords="carrés">
   <p>Voici le texte de cet exemple</p>
</exemple>
			

Pour ne pas avoir de style de mise en page, utilisez l'attribut style="" ou style="transparent".

<exemple titre="Sans style" style=""">
   <p>Voici le texte de cet exemple</p>
</exemple>