Doc : comment "!" and "_" and "~" modifiers of LSformat
[ldapsaisie.git] / doc / conf / LSformat.docbook
1 <sect2 id='config-LSformat'>
2 <title>Format paramétrable</title>
3 <para>Un <emphasis>format paramétrable</emphasis> est une chaîne de caractères
4 contenant des mots clés formés comme dans l'exemple suivant&nbsp;:
5 <programlisting linenumbering="unnumbered">%{[nom du mot clé][:A][:B][! ou _][~]}</programlisting>
6 Le nom du mot clé peut contenir des lettres de "a" à "z", de "A" à "Z" et des
7 chiffres de 0 à 9. Ces mots clés seront remplacés par les valeurs passées en
8 paramètres et liées au contexte d'utilisation. Les paramètres <emphasis>:A</emphasis> et 
9 <emphasis>:B</emphasis> permettent d'extraire une partie de la chaîne complète
10 avant la substitution.</para>
11
12 <para>Le paramètre <varname>A</varname> correspond, lorsque
13 <varname>B</varname> n'est pas défini, au nombre maximum de caractères à 
14 extraire de la chaîne de substitution. <emphasis>A</emphasis> doit être un entier
15 dont le signe influ, comme expliqué ci-dessous&nbsp;:
16 <itemizedlist>
17   <listitem>
18   <simpara>Si <varname>A</varname> est positif, les <varname>A</varname>
19   premiers caractères de la chaîne de substitution seront extraits.</simpara>
20   </listitem>
21   
22   <listitem>
23   <simpara>Si <varname>A</varname> est négatif, les <varname>|A|</varname> 
24   derniers caractères de la chaîne de substitution seront extraits.</simpara>
25   </listitem>
26 </itemizedlist>
27 Lorsque le paramètre <varname>B</varname> est défini, 
28 <varname>A</varname> correspond au rang du premier caractère à partir duquel la
29 chaîne de substitution sera découpée et <varname>B</varname> le nombre maximum
30 de caractères à extraire. Le signe de <varname>B</varname> influera comme expliqué
31 dans le premier cas.
32 </para>
33 <para>Les paramètres <emphasis>!</emphasis> ou <emphasis>_</emphasis> permettre respectivement de forcer la mise en majuscule ou en minuscule de la valeur de substitution.</para>
34
35 <para>Le paramètre <emphasis>~</emphasis> permet qu'en a lui de forcer la suppression des accents dans la valeur de substitution.</para>
36
37 <important><simpara>Lorsque qu'une seule valeur clé est disponible pour la 
38 substitution, le nom du mot clé n'importe pas. Tous les mots clés trouvés dans
39 le format seront remplacés par cette seule valeur.</simpara></important>
40 </sect2>