help: add pages about substitution variables and template mechanism

help/fr/misc-ezt.page

@@ -0,0 +1,68 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide" id="misc-ezt" xml:lang="fr">
+
+<info>
+  <revision docversion="0.1" date="2013-07-06" status="draft"/>
+  <credit type="author">
+    <name>Frédéric Péters</name>
+    <email>fpeters@entrouvert.com</email>
+  </credit>
+
+</info>
+
+<title>Mécanique de template</title>
+
+<p>
+De nombreux éléments permettent l'utilisation d'un système simple permettant
+de générer du contenu variant suivant certaines données. L'exemple le plus
+simple peut être le contenu d'un courriel, dans lequel l'utilisateur se voit
+souhaiter la bienvenue.
+</p>
+
+<example>
+<code>
+Bienvenue [session_user_display_name],
+
+Toute l'équipe de [site_name] vous remercie de votre inscription
+et vous souhaite une agréable visite.
+</code>
+</example>
+
+<p>
+À l'usage, les contenus proposés entre crochets seront substitués, pour donner
+le résultat suivant :
+</p>
+
+<example>
+<code>
+Bienvenue <var>Lætitia</var>,
+
+Toute l'équipe de <var>Quizz du jour</var> vous remercie de votre inscription
+et vous souhaite une agréable visite.
+</code>
+</example>
+
+<p>
+Il est également possible d'afficher du contenu de manière conditionnelle,
+en utilisant la syntaxe <code>[if-any]...[end]</code> ou <code>[if-any]...[else]...[end]</code>.
+</p>
+
+<example>
+<code>
+Pour rappel, voici les renseignements que vous nous avez fournis :
+
+[if-any form_var_regime_alimentaire]
+ - Régime alimentaire : [form_var_regime_alimentaire]
+[else]
+ - Aucun régime alimentaire précisé.
+[end]
+</code>
+</example>
+
+<note><p>
+Pour plus d'informations, il existe une
+<link href="https://code.google.com/p/ezt/wiki/Syntax#Directives">référence
+détaillée</link> sur le système de template (en anglais).
+</p></note>
+
+</page>

help/fr/misc-substvars.page

@@ -0,0 +1,197 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="guide" id="misc-substvars" xml:lang="fr">
+
+<info>
+  <link type="seealso" xref="misc-ezt" />
+  <revision docversion="0.1" date="2013-07-06" status="draft"/>
+  <credit type="author">
+    <name>Frédéric Péters</name>
+    <email>fpeters@entrouvert.com</email>
+  </credit>
+
+</info>
+
+<title>Variables de substitution</title>
+
+<p>
+<app>w.c.s.</app> dispose d'un système générique appelé « variables de
+substittions » qui permet de faire référence à des données internes,
+provenant du système, d'un formulaire, d'un champ, etc.
+</p>
+
+<p>
+Ce système est particulièrement utile dans le paramétrage du contenu d'un
+courriel ou dans la définition d'une logique de traitement d'un formulaire,
+mais est également accessible depuis le thème, pour le préremplissage de
+champs, etc.
+</p>
+
+<section>
+  <title>Variables système</title>
+
+  <p>
+  Ces variables sont accessibles à tout endroit du site.
+  </p>
+
+  <table shade="rows">
+    <tr>
+      <td><p><code>site_name</code></p></td>
+      <td><p>Le titre du site</p></td>
+    </tr>
+    <tr>
+      <td><p><code>site_theme</code></p></td>
+      <td><p>L'identifiant du thème en cours</p></td>
+    </tr>
+    <tr>
+      <td><p><code>site_url</code></p></td>
+      <td><p>L'adresse du site</p></td>
+    </tr>
+    <tr>
+      <td><p><code>site_url_backoffice</code></p></td>
+      <td><p>L'adresse vers le backoffice du site</p></td>
+    </tr>
+    <tr>
+      <td><p><code>site_lang</code></p></td>
+      <td><p>Le code de la langue utilisée par le site</p></td>
+    </tr>
+    <tr>
+      <td><p><code>today</code></p></td>
+      <td><p>La date du jour</p></td>
+    </tr>
+    <tr>
+      <td><p><code>now</code></p></td>
+      <td><p>La date et l'heure du jour</p></td>
+    </tr>
+    <tr>
+      <td><p><code>session_user_display_name</code></p></td>
+      <td><p>Le nom de l'utilisateur connecté</p></td>
+    </tr>
+    <tr>
+      <td><p><code>session_user_email</code></p></td>
+      <td><p>L'adresse électronique de l'utilisateur connecté</p></td>
+    </tr>
+  </table>
+
+  <p>
+  À l'intérieur d'une catégorie, les variables suivantes sont également
+  définies :
+  </p>
+
+  <table shade="rows">
+    <tr>
+      <td><p><code>category_name</code></p></td>
+      <td><p>L'intitulé de la catégorie</p></td>
+    </tr>
+    <tr>
+      <td><p><code>category_description</code></p></td>
+      <td><p>La description de la catégorie</p></td>
+    </tr>
+    <tr>
+      <td><p><code>category_id</code></p></td>
+      <td><p>L'identifiant de la catégorie</p></td>
+    </tr>
+  </table>
+
+  <note><p>
+  Des variables supplémentaires peuvent également être définies par
+  l'administrateur système, via des variables d'environnement ou la
+  configuration de l'instance de w.c.s.
+  </p></note>
+
+</section>
+
+<section>
+  <title>Variables de formulaire</title>
+
+  <section>
+    <title>Informations générales</title>
+
+    <table shade="rows">
+    <tr>
+      <td><p><code>form_receipt_date</code></p></td>
+      <td><p>La date de réception du formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_receipt_time</code></p></td>
+      <td><p>La date et l'heure de réception du formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_number</code></p></td>
+      <td><p>Le numéro attribué au formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_url</code></p></td>
+      <td><p>L'adresse vers la vue du formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_url_backoffice</code></p></td>
+      <td><p>L'adresse vers le formulaire dans le backoffice</p></td>
+    </tr>
+    </table>
+  </section>
+
+  <section>
+    <title>Informations sur l'utilisateur</title>
+
+    <p>
+    Les données contiennent aussi des informations sur l'utilisateur ayant
+    complété le formulaire.
+    </p>
+
+    <table shade="rows">
+    <tr>
+      <td><p><code>form_user_display_name</code></p></td>
+      <td><p>Le nom de l'utilisateur</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_user_email</code></p></td>
+      <td><p>L'adresse électronique de l'utilisateur</p></td>
+    </tr>
+    </table>
+  </section>
+
+  <section>
+    <title>Données du formulaire</title>
+
+    <table shade="rows">
+    <tr>
+      <td><p><code>form_details</code></p></td>
+      <td><p>L'ensemble des champs et de leur valeurs</p></td>
+    </tr>
+    </table>
+
+    <p>
+    Il est également possible au moment de la définition d'un champ, de lui
+    affecter un nom de variable, cela rendra la valeur associée à ce champ
+    accessible via une variable de la forme <code>form_var_<var>variable du
+    champ</var></code> (par exemple : <code>form_var_courriel</code>).
+    </p>
+
+  </section>
+
+  <section>
+    <title>Statut et données relatives au traitement</title>
+
+    <table shade="rows">
+    <tr>
+      <td><p><code>form_status</code></p></td>
+      <td><p>Le statut actuel du formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_previous_status</code></p></td>
+      <td><p>Le statut précédent du formulaire</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_status_changed</code></p></td>
+      <td><p>Un booléen précisant que le formulaire vient de changer de statut</p></td>
+    </tr>
+    <tr>
+      <td><p><code>form_evolution</code></p></td>
+      <td><p>L'ensemble de l'historique du traitement</p></td>
+    </tr>
+  </table>
+  </section>
+
+</section>
+
+</page>

help/fr/wf-form.page

@@ -42,9 +42,9 @@ que la valeur qui sera renseignée par le champ soit sauvegardée.
 Il est nécessaire également de définir à qui sera présenté le formulaire, via
 le champ <gui>À</gui>, et de lui attribuer un <gui>Nom de variable</gui> qui
 permettra aux valeurs sauvegardées d'être accessibles au niveau des <link
-xref="form-substvars">variables de substitution</link>, sous la forme
+xref="misc-substvars">variables de substitution</link>, sous la forme
 <code><var>variable du formulaire</var>_var_<var>variable du
-champ</var></code> (par exemple : <var>contact_interne_var_telephone</var>).
+champ</var></code> (par exemple : <code>contact_interne_var_telephone</code>).
 </p>
 
 </page>