help: add documentation

This commit is contained in:
Pierre Cros 2013-08-12 13:19:34 +02:00 committed by Frédéric Péters
parent ee0df52147
commit 4988f54dc4
65 changed files with 2286 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
help/fr/figures/annonce.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB

BIN
help/fr/figures/nom_var.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

147
help/fr/form_champs.page Normal file
View File

@ -0,0 +1,147 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="form_champs">
<title>2. Ajouter des champs dans un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
</info>
<section id="creation">
<title>Création des champs</title>
<p>Pour créer le contenu de votre formulaire, vous devez y ajouter des champs. Ce sont les questions auxquelles devront répondre les usagers d'une part, des éléments de mise en forme (<link xref="form_champs#champ_affiche_info">Nouvelle page, Titre, Sous-titre, Commentaire</link>) d'autre part.</p>
<p>Sur la page d'édition du formulaire que vous venez de créer ou que vous souhaitez éditer, dans la partie <em>Champs</em> vous avez un lien <em>éditer</em> :</p>
<figure>
<media type="image" src="figures/form_champ_editer.png" />
</figure>
<p>En cliquant dessus vous êtes redirigé sur la page de création des champs. Vous avez sur cette page une section <em>Nouveau champ</em> :</p>
<figure>
<media type="image" src="figures/page_ajout_champ.png" />
</figure>
<p>
Le <em>Libellé</em> est le texte qui sera affiché à l'utilisateur et <em>Type</em> propose une liste de <link xref="types_champs">différents types de champ</link>. Les types disponibles permettent de proposer à l'usager d'entrer une information texte, une date, de télécharger un fichier, de choisir une réponse dans une liste, de lui afficher une information ou encore de créer plusieurs pages, etc.</p>
<p>Pour créer un champ il faut obligatoirement saisir son libellé et choisir son type, puis, il faut cliquer sur <em>Ajouter</em>. Une fois crée le champ apparaît sur la page :</p>
<figure>
<media type="image" src="figures/liste_champ.png" />
</figure>
<p>Chaque ligne est un champ, à gauche se trouve le libellé et à droite son type afin d'identifier rapidement les champs.</p>
<p>Pour éditer un champ placez votre souris sur celui qui vous intéresse,un petit menu apparaît :</p>
<figure>
<media type="image" src="figures/form_champ_menu_survol_souris.png" />
</figure>
<p>Vous pouvez supprimer le champ, le dupliquer ou l'éditer.</p>
<p>Selon le type de champ, la page d'édition vous proposera divers champs et options à paramétrer.</p>
</section>
<section id="options_champs">
<title>Options des champs</title>
<p>Chaque champ peut-être édité en cliquant sur le lien éditer qui apparaît au moment du survol.</p>
<p>Il existe deux types de champs, ceux qui demandent à l'usager d'entrer une information et ceux qui lui donnent une information (les champs de mise en forme). À l'exception des champs de mise en forme (<link xref="form_champs#champ_affiche_info">Nouvelle page, Titre, Sous-titre, Commentaire</link>), ils offrent tous les options suivantes :</p>
<list>
<item><p>Libellé : le texte du champs tel qu'il sera présenté à l'utilisateur.</p></item>
<item><p>Obligatoire : il s'agit d'une case à cocher qui fixe le caractère obligatoire d'une réponse pour le répondant, si la case n'est pas cochée, la réponse à la question est optionnelle.</p></item>
<item><p>Remarque : permet d'apporter une aide au répondant. Dans le cas d'un champ adresse électronique, on pourra faire figurer dans cette option : "par exemple : francis.kuntz@wanagro.com", et ce message sera affiché à l'utilisateur en-dessous du champ adresse électronique.</p></item>
<item><p>Affichage dans les listings : il n'est pas forcément pertinent que tous les champs figurent dans le listing de back-office d'autant que dans le cas de formulaires comprenant beaucoup de champs, le listing n'est pas très lisible si tous sont affichés. Cette option permet donc, par le biais d'une case à cocher de déterminer si le champ concerné doit figurer dans le listing back-office.</p></item>
<item><p>Classe supplémentaire pour les styles CSS : permet d'indiquer une classe CSS pour le champ. Cette classe doit évidemment exister dans la feuille de style du thème choisi pour être opérante.</p></item>
<item><p>Nom de variable : permet d'attribuer un identifiant au champ en question. Cet identifiant pourra ensuite être utilisé pour faire des <link xref="form_conditionnel">formulaires conditionnels</link>.</p></item>
</list>
</section>
<section id="types_champs">
<title>Les différents types de champs</title>
<section id="champ_demande_info">
<title>Champs demandant une information</title>
<p>Ces champs exigent que l'utilisateur entre du texte, une date, choisissent une ou plusieurs réponse(s), joigne un fichier....</p>
<list>
<item><p>Texte : C'est le champ de base, utilisé pour demander au répondant de fournir une information en texte libre. Le champ texte permet, dans sa configuration de base, une réponse comprenant des lettres et des chiffres et limitée à 20 caractères. Tout ceci peut être modifié aisément en éditant le champs. En plus des options communes, il offre :
<list>
<item><p>Longueur de ligne : permet d'indiquer la largeur du champs (par défaut 20).</p></item>
<item><p>Regex de validation : ce champ permet d'appliquer une règle (en respectant la sysntace des expressions régulière Python) pour contrôler ce qui est saisi par l'utilisateur. Exemple de règles :
<list>
<item><p>Imposer la saisie d'un numéro de téléphone à 10 chiffres : \d{10}$</p></item>
<item><p>Idem mais avec la possibilité d'avoir des espaces entre les groupes de 2 chiffres : \d{2}\D*\d{2}\D*\d{2}\D*\d{2}\D*\d{2}$</p></item>
<item><p>Code postal à 5 chiffres : \d{5}$</p></item>
<item><p>Valeur numérique : \d+$</p></item>
</list>
</p></item>
<item><p>La liste déroulante "Préremplir", permet, de 3 façon différente, de pré-remplir le champ :</p></item>
<list>
<item><p>« Texte », qui en cliquant sur le bouton "appliquer" vous permettra de saisir une valeur fixe qui sera affichée indifféremment à tous les répondants.</p></item>
<item><p>« Champ utilisateur» qui permet de sélectionner une des caractéristiques du profil de l'utilisateur (nom, adresse téléphone...) pour alimenter le champs</p></item>
<item><p>« Formule Python » qui permet d'écrire une requête Python pour aller récupérer une information pouvant pré-remplir le champ.</p></item>
</list>
<item>Source de données externe : permet d'aller interroger un référentiel distant pour en extraire une information destinée à alimenter le formulaire.</item>
</list>
</p></item>
<item><p>Texte long : identique au champ Texte mais il s'étend sur plusieurs lignes. Dans les navigateurs récents, la taille du bloc de texte est modifiable par l'utilisateur en cliquant/déplaçant son coin inférieur droit. Par défaut le nombre de caractères par ligne est fixé à 20 et le nombre de lignes à 3. Pour un affichage occupant la largeur de la page, 70 caractères par ligne est une bonne valeur. 10 lignes par bloc permettent une réponse longue, sachant que si l'utilisateur dépasse, il disposera d'une barre d'ascenseur. L'option « texte préformatté » Permet de conserver les sauts à la lignes et les espaces supérieur à 1 caractère dans la réponse de l'usager.</p></item>
<item><p>Courriel : C'est un champ Texte sur lequel un contrôle est opéré pour vérifier que c'est bien une adresse électronique valable qui est saisie. Le répondant devra donc mentionner dans ce champ une adresse de courriel valide. Le contrôle porte à la fois sur la forme de l'adresse et sur la validité du nom de domaine.</p></item>
<item><p>Case à cocher : il s'agit d'une case à cocher permettant par exemple d'obtenir le consentement du demandeur.</p></item>
<item><p>Upload de fichier : permet à l'utilisateur de joindre un fichier au formulaire, par exemple une pièce justificative scannée.</p></item>
<item><p>Date : Propose à l'utilisateur de choisir une date (en l'écrivant ou en la sélectionnant dans un calendrier). Ce champs offre les options suivantes :
<list>
<item><p>Date minimale : empêche l'utilisateur de choisir une date
antérieure à celle définie ici.</p></item>
<item><p>La date doit être dans le futur : impose à l'utilisateur de choisir une date postérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date minimale</em>.</p></item>
<item><p>Date maximale : empêche l'utilisateur de choisir une date postérieure à la date définie ici.</p></item>
<item><p>La date doit être dans le passé : impose à l'utilisateur de choisir une date antérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date maximale</em>.</p></item>
<item><p>La date peut être le jour présent : option qui n'est utile que combinée aux options précédentes et qui leur ajoute la possibilité de saisir la date du jour.</p></item>
</list>
</p></item>
<item><p>Liste : Ce champ permet l'affichage d'une liste déroulante au répondant. « Éléments », permet de définir les différentes possibilités de réponse. Ajoutez autant d'éléments que nécessaire à votre liste. Vous pouvez choisir d'afficher les réponses sous forme de bouton radio à l'aide de la case à cocher prévue à cet effet.</p></item>
<item><p>Liste à choix multiples : identique à liste mais permet à l'utilisateur de choisir plusieurs répondes. Il est possible de limiter le nombre de choix possible avec l'option <em>Nombre maximal de choix</em>, 0 signifiant qu'il n'y a aucune limitation.</p></item>
<item><p>Tableau : Ce champ permet de mettre en place un tableau dans le formulaire. Lorsqu'on le paramètre on choisit le nombre de colonnes et de lignes qu'il va compter et les libellés choisis apparaîtront au-dessus des colonnes (pour les éléments saisis sous "Colonne") et devant les lignes (pour les éléments saisis sous "Lignes").</p></item>
<item><p>Tableau de listes : identique au type « Tableau » mais le contenu de chaque cellule est une liste définie dans l'option « Éléments » du champs</p></item>
<item><p>Tableau de longueur libre : identique au type « Tableau » mais chaque fois qu'une ligne est remplie par l'utilisateur, il peut compléter une nouvelle ligne, le nombre de ces dernières n'est pas limité. Ce type offre par ailleurs la possibilité de faire le total des colonnes en cochant l'option « Ajouter une ligne de total ».</p></item>
<item><p>Éléments classés : Affiche à l'usager une liste de propositions précédées d'une zone de saisie permettant d'indiquer par un chiffre le classement qu'il souhaite donner à chacune d'entre elles. </p></item>
</list>
</section>
<section id="champ_affiche_info">
<title>Champs affichant une information</title>
<p>Ces champs permettent la mise en forme du formulaire.</p>
<list>
<item><p>Titre : permet d'insérer un titre dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Sous-titre : permet d'insérer un sous-titre dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Commentaire : permet d'insérer un commentaire dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Nouvelle page : permet de spécifier qu'une nouvelle page doit commencer à cet endroit. Le champ nouvelle page permet donc de créer des <link xref="form_multipage">formulaires multi-pages</link>. Le libellé des champs nouvelle page sera affiché à l'utilisateur dans un cadre à part, lui permettant d'avoir une vue d'ensemble du formulaire et de savoir sur quelle page il se trouve. Le champ nouvelle page permet également de gérer la notion d'affichage conditionnel : certaines pages ne seront affichées qu'en fonction d'une réponse à une question précédente (cf. les <link xref="form_conditionnel">formulaires conditionnels</link>). À noter qu'un formulaire multi-pages doit obligatoirement commencer par un champ de ce type.</p></item>
</list>
<note>
<title>Différences entre champs « Commentaire » et option « Remarque »</title>
<p>Il est souvent préférable de ne pas utiliser le champs « Commentaire » pour donner des indications sur la façon de remplir un champ particulier : il est préférable d'utiliser l'option « Remarque » du champ en question pour ce faire, le texte sera alors plus explicitement lié à ce dernier.</p>
</note>
</section>
</section>
</page>

View File

@ -0,0 +1,78 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="form_conditionnel">
<title>4. Créer un formulaire conditionnel</title>
<info>
<link type="guide" xref="index#formulaires" group="#first"/>
<link type="guide" xref="formulaires" group="#first" />
</info>
<p>Les formulaire conditionnels permettent de rendre un formulaire dynamique, d'afficher ou non certaines pages en fonction des réponses de l'utilisateur à certaines questions. L'affichage des pages peut en effet être soumis à des « conditions ». Ces conditions sont remplies, ou non, en fonctions des réponses de l'utilisateur.</p>
<section id="form_variable">
<title>Nom de variable</title>
<p>Les noms de variable sont des identifiants que l'on peut donner à chaque champ. Donner un nom de variable est généralement inutile, mais cela devient intéressant lorsque le champ est une question qui va être utilisée pour conditionner l'affichage d'une page. On utilisera en effet ce nom de variable pour écrire la condition décidant de l'affichage d'une page.</p>
<p>Les noms de variables sont soumis à des règles, ils doivent contenir des chiffres ou des lettres, sans accentuation ni espaces (on remplace généralement ces derniers par le caractère underscore).</p>
</section>
<section>
<title>Pages conditionnelles</title>
<p>Les champs de type « Nouvelle page » sont les seuls à posséder une option particulière « Condition » accessible lorsqu'on les édite. C'est dans ce champ que l'on va écrire la règle décidant si cette page doit être affichée ou non. Il existe deux façons d'écrire cette condition :</p>
<section>
<title>Avec un nom de variable</title>
<p>Nous avons vu que l'on pouvait donner un nom de variable à un champ :</p>
<figure>
<media type="image" src="figures/nom_var.png" />
</figure>
<p>Le champs en question est une liste qui contient plusieurs réponses, disons deux réponses pour l'exercice : </p>
<list>
<item><p>1ère catégorie</p></item>
<item><p>2ème catégorie</p></item>
</list>
<p>La condition s'écrira alors selon la forme suivante :</p>
<figure>
<media type="image" src="figures/condition_type_chien.png" />
</figure>
<p>On voit que l'on ajoute avant le nom de la variable le préfixe <em>var_</em>. Puis, on utilise l'opérateur <em>==</em> qui signifie « égal à », enfin on ajoute entre guillemets la valeur de la réponse attendue pour que la condition soit respectée. Si l'utilisateur sélectionne « 1ère catégorie » dans la liste déroulante, la page « Chien de 1ère catégorie » lui sera affichée, si il choisit autre chose, il ne la verra pas et passera directement à la page suivante (ou aura terminé le questionnaire s'il n'y a pas de page suivante).</p>
<note style="warning">
<title>Respectez la case !</title>
<p>La casse est importante (majuscule / minuscule). Si vous ne la respectez pas dans l'écriture de la condition, cela ne fonctionnera pas.</p>
</note>
</section>
<section>
<title>Avec l'identifiant de l'URL</title>
<p>Plutôt que d'utiliser un nom de variable, on peut se contenter de son identifiant, récupérable dans l'URL du champ lorsqu'on l'édite. Par exemple l'URL http://wcs.exemple.org/admin/forms/28/fields/15/ nous permet de savoir que le champs édité a le numéro 15. Il suffit de faire précéder ce chiffre d'un f (pour « field ») afin d'obtenir l'identifiant.</p>
<p>La condition peut alors s'écrire sous la forme :</p>
<figure>
<media type="image" src="figures/condition_id_type_chien.png" />
</figure>
<p>f15 remplace ici le nom de variable utilisé dans l'exemple précédent, tout le reste est identique. Cette forme de notation est utile pour les experts qui ne souhaitent pas s'embarrasser avec des noms de variable mais elle est moins lisible.</p>
<note style="warning">
<title>Respectez la case !</title>
<p>La casse est importante (majuscule / minuscule). Si vous ne la respectez pas dans l'écriture de la condition, cela ne fonctionnera pas.</p>
</note>
</section>
</section>
</page>

View File

@ -0,0 +1,49 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="form_import_export">
<title>5. Importer / exporter un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first"/>
<link type="guide" xref="formulaires" group="#first" />
</info>
<p>Il est possible d'importer ou exporter un formulaire sous forme de fichier texte structuré portant l'extension .wcs. C'est-à-dire que vous pouvez ajouter dans votre solution Au Quotidien un formulaire conçu ailleurs, mais également partager un de vos formulaires en l'exportant dans un fichier de ce type.</p>
<note style="important">
<p> Il existe un <link href="http://www.au-quotidien.com/fr/community/">site communautaire</link> pour uploader et télécharger des formulaires Au Quotidien, vous êtes encouragé à partager vos créations et à récupérer les formulaires vous intéressant.</p>
</note>
<section>
<title>Import</title>
<p>L'import de formulaire s'effectue depuis un fichier au format .wcs.</p>
<p>Pour importer un formulaire enregistré sur votre ordinateur, allez dans votre espace personnel, <em>Admin</em>, puis dans <em>Formulaires</em>. Vous avez le lien <em>Import</em> : </p>
<figure>
<media type="image" src="figures/form_lien_import.png" />
</figure>
<p>En cliquant dessus, une fenêtre s'affiche vous permettant de sélectionner sur votre ordinateur le fichier .wcs à importer dans Au Quotidien.</p>
</section>
<section>
<title>Export</title>
<p>Pour exporter un formulaire vous devez vous rendre sur sa page d'édition, dans votre espace personnel, <em>Admin</em> puis dans <em>Formulaires</em> et cliquez sur le formulaire à exporter.</p>
<p>Sur la page vous avez un menu à droite :</p>
<figure>
<media type="image" src="figures/form_lien_export.png" />
</figure>
<p>Lorsque vous cliquez dessus, une fenêtre de votre navigateur s'affiche pour exporter le formulaire dans un fichier au format .wcs sur votre ordinateur.</p>
</section>
</page>

View File

@ -0,0 +1,26 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="form_multipage">
<title>3. Créer un formulaire multipages</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
</info>
<p>Pour créer un formulaire multi-page il suffit de faire figurer comme premier champ du formulaire, un champ de type « Nouvelle page », de mettre à sa suite tous les champs appartenant à la première page. On met ensuite un autre champ nouvelle page et à sa suite tous les champs relatifs à cette nouvelle page et ainsi de suite.</p>
<figure>
<title>Formulaire multi-page</title>
<media type="image" src="figures/form_multipage.png" />
</figure>
<p>Les différentes pages créées apparaissent dans un cadre spécifique sur l'interface publique, dans la colonne de gauche :</p>
<figure>
<title>Titre des pages dans la colonne de gauche</title>
<media type="image" mime="image/png" src="figures/colonne_multipage.png" >
</media>
</figure>
</page>

104
help/fr/form_simple.page Normal file
View File

@ -0,0 +1,104 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="form_simple">
<title>1. Créer un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
</info>
<p>Pour créer un formulaire, allez dans l'interface d'amdinistration puis sur <em>Formulaire</em>.</p>
<p>Cliquez sur <em>Nouveau formulaire</em>, une fenêtre apparaît :</p>
<figure>
<media type="image" src="figures/form_creation.png" />
</figure>
<p>En validant vous serez redirigé vers la page d'édition du formulaire :</p>
<figure>
<media type="image" src="figures/page_edition_form.png" />
</figure>
<p>C'est ici que vous allez configurer l'ensemble du formulaire. Cette page
est divisée en 3 parties :</p>
<section id="acces">
<title>Accès</title>
<p>Cette partie vous permet de classer le formulaire et de déterminer qui pourra l'utiliser :</p>
<list>
<item>
<p>Catégorie : permet de classer le formulaire dans une catégorie, les formulaires sont affichés par catégorie sur la page d'accueil.</p>
</item>
<item>
<p>Workflow : Détermine le workflow associé au formulaire.</p>
</item>
<item>
<p>Rôle du destinataire : Le destinataire est la personne chargée de traiter la demande, elle accède à la demande depuis le backoffice. La liste déroulante destinataire présente l'ensemble des "Rôles" existant dans le système.</p>
</item>
<item>
<p>Rôle de l'expéditeur : L'expéditeur est la personne qui pourra remplir le formulaire (utilisateur enregistré ou non etc), vide signifie tout le monde</p>
</item>
<item>
<p>Accès en lecture: Définit qui sera autorisé à voir le formulaire complété par l'usager (en plus de la personne qui le reçoit et le traite)
</p>
</item>
</list>
<note>
<title>Activer / Désactiver un formulaire :</title>
<p>Lorsqu'un formulaire est désactivé (c'est l'état par défaut après sa création), il n'est pas visible par les usagers et n'est pas utilisable. Son activation le rend visible et utilisable (en fonction des options d'accès positionnées).</p>
</note>
<note style="important">
<title>Attribuer un workflow :</title>
<p>La chaîne de traitement du formulaire se basera sur le workflow attribué. Les workflows permettent de gérer de manière très fine l'évolution de la demande d'un usager. Il permet aussi l'automatisation de certaines tâches les rendant plus rapide et assurant leur traitement. Voir la page dédiée à l'<link
xref="workflows_form">attribution d'un workflow à un formulaire</link>.</p>
</note>
</section>
<section id="options">
<title>Options</title>
<p>Cette partie vous permet lorsque vous cliquez sur « changer » :</p>
<list>
<item><p>d'activer ou désactiver le formulaire. Un formulaire désactivé n'est pas accessible par les utilisateurs</p></item>
<item><p>d'inclure une page de confirmation. Si cette option est choisie, une page récapitulative permet à l'utilisateur de vérifier sa saisie avant validation.</p></item>
<item><p>de choisir des dates de publication et d'expiration pour un formulaire que vous souhaiteriez plublier sur une période donnée.</p></item>
<item><p>de n'autoriser qu'un formulaire par utilisateur. C'est utile lors de l'organisation de consultations par exemple, pour lesquelles on ne souhaite pas que les utilisateurs puissent répondre plusieurs fois.</p></item>
<item><p>d'autoriser l'utilisateur à conserver ses brouillons. C'est utile pour les formulaires long pouvant nécessiter d'être complété en plusieurs fois. L'utilisateur doit nécessairement être authentifié pour pouvoir bénéficier de cette fonctionnalité.</p></item>
<item><p>de rediriger un formulaire désactivé vers une autre URL. Si une URL est saisi dans ce champs et que le formulaire est désactivé, le formulaire sera tout de même affiché et un clic sur ce dernier redirigera vers l'URL en question.</p></item>
</list>
</section>
<section id="champs">
<title>Champs</title>
<p> Cette partie vous permet de créer les différents champs de votre formulaire, voyez la page consacrée à l'<link xref="champs">ajout de champs</link>. Les champs peuvent être de différents types :</p>
<list>
<item><p><link xref="form_champs#types_champs">Texte</link></p></item>
<item><p><link xref="form_champs#types_champs">Texte Long</link></p></item>
<item><p><link xref="form_champs#types_champs">Courriel</link></p></item>
<item><p><link xref="form_champs#types_champs">Case à cocher</link></p></item>
<item><p><link xref="form_champs#types_champs">Upload de fichier</link></p></item>
<item><p><link xref="form_champs#types_champs">Date</link></p></item>
<item><p><link xref="form_champs#types_champs">Liste</link></p></item>
<item><p><link xref="form_champs#types_champs">Liste à choix multiple</link></p></item>
<item><p><link xref="form_champs#types_champs">Tableau</link></p></item>
<item><p><link xref="form_champs#types_champs">Tableau de listes</link></p></item>
<item><p><link xref="form_champs#types_champs">Éléments classés</link></p></item>
<item><p><link xref="form_champs#types_champs">Titre</link></p></item>
<item><p><link xref="form_champs#types_champs">Sous-titre</link></p></item>
<item><p><link xref="form_champs#types_champs">Commentaire</link></p></item>
<item><p><link xref="form_champs#types_champs">Nouvelle page</link></p></item>
</list>
</section>
</page>

19
help/fr/formulaires.page Normal file
View File

@ -0,0 +1,19 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="formulaires">
<title>Formulaires</title>
<info>
<link type="guide" xref="index" group="1"/>
<desc>Comment gérer les formulaires</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<p>Les formulaires permettent aux usagers d'effectuer une demande auprès de la collectivité. Ils autorisent un niveau de personnalisation important, les rendant adaptés à de nombreux usages.</p>
</page>

42
help/fr/index.page Normal file
View File

@ -0,0 +1,42 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="index">
<title>Documentation Au quotidien</title>
<p>L'offre Au quotidien s'appuie sur le logiciel libre w.c.s.</p>
<p>w.c.s est un logiciel permettant de générer des formulaires et des consultations en ligne et de les intégrer dans un workflow. Configuré par défaut pour des besoins basiques, il offre une personnalisation poussée permettant de l'adapter à de nombreux usages différents. Un ensemble de formulaires mettant en avant différentes fonctionnalités de w.c.s est disponible :</p>
<links type="topic" groups="
1
2
3
4
5
6
"/>
<section id="formulaires" style="2column">
<title>Formulaires</title>
</section>
<section id="workflows" style="2column">
<title>Workflows</title>
</section>
<section id="utilisateur_et_role" style="2column">
<title>Utilisateurs et rôles</title>
</section>
<section id="personnalisation" style="2column">
<title>Personnaliser Au Quotidien</title>
</section>
<section id="avancee" style="2column">
<title>Utilisation avancée</title>
</section>
</page>

40
help/fr/logs.page Normal file
View File

@ -0,0 +1,40 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="logs">
<title>2. Voir les évènements survenus sur la plate-forme (logs)</title>
<info>
<link type="guide" xref="index#avancee" />
<link type="guide" xref="utilisation_avancee" group="#first" />
</info>
<section id="les_logs">
<title>Les logs</title>
<p>Allez dans votre espace personnel puis <em>Admin</em> et <em>Logs</em>.</p>
<p>Les logs, ou journaux, enregistre chaque activité des utilisateurs ainsi que les erreurs de l'application. Les logs se présentent sous forme de colonnes :</p>
<terms>
<item>
<title>Horodatage</title>
<p>Heure d'enregistrement de l'activité</p>
</item>
<item>
<title>Utilisateur</title>
<p>Utilisateur originaire de l'évènement</p>
</item>
<item>
<title>Message</title>
<p>L'évènement</p>
</item>
</terms>
<p>Les couleurs en fond de chaque ligne permettent de différencier plus facilement les utilisateurs, excepté lorsque le message est rouge. Cela signifie qu'une erreur est l'évènement.</p>
<p>Il est possible de télécharger l'ensemble des logs dans un fichier texte au format .log en cliquant sur <em>Télécharger le fichier de log</em>.</p>
</section>
</page>

View File

@ -0,0 +1,70 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="param_texte_message">
<title>1. Paramétrer les textes et messages</title>
<info>
<link type="guide" xref="index#personnalisation" />
<link type="guide" xref="perso_aq" group="#first" />
</info>
<section id="envoyer_annonce_utilisateur">
<title>Les textes</title>
<p>L'ensemble des textes affichés sur l'interface publique peuvent être modifiés directement en cliquant sur le lien <em>Modifier le texte</em> près du texte désiré (ce lien n'apparaît que pour les utilisateurs ayant les droits nécessaires) :</p>
<figure>
<media type="image" src="figures/modifier_texte.png" />
</figure>
<p>Ces textes sont aussi éditable depuis l'interface d'administration.</p>
<code>
Divers
Aide
Connexion par fournisseur d'identités
Déclaration d'accessibilité
Informations de contact
Informations éditeur
Page d'accueil
Présentation du profil
Texte d'assistance à côté des erreurs
Texte de bienvenue pour les utilisateurs identifiés
Texte de bienvenue pour les utilisateurs non-identifiés
Texte en haut de la page de profil
Texte sur la page d'inscription aux annonces
Texte à l'abonnement aux annonces SMS quand configuré en démo
Formulaires
Message quand un formulaire a été enregistré
Message quand un formulaire a été enregistré, et que le formulaire est créé pour n'autoriser qu'un seul exemplaire par utilisateur
Message quand un formulaire est affiché pour validation
Identification
Message quand le courriel pour confirmation de création a été envoyé
Texte après l'envoi du message de confirmation de suppression
Texte en haut de la page d'inscription
Texte en haut de la page de connexion
Texte liant la page de connexion à la page de création de compte
Texte quand le compte est confirmé par l'utilisateur
Texte quand le compte est confirmé par l'utilisateur mais en attente de modération
Texte quand un changement de courriel est confirmé
Texte quand un changement de courriel est demandé
Texte quand un changement de courriel est en attente de confirmation
Texte quand un courriel avec un jeton de changement de mot de passe a été envoyé
Texte quand un jeton de changement de mot de passe invalide est utilisé.
Texte quand un nouveau mot de passe a été envoyé
Texte quand un utilisateur veut supprimer son compte
Texte sur la page d'identification, liant vers la page de demande de mot de passe oublié
Texte sur les pages de demande de mot de passe oublié
Paiements
Message en haut d'un paiement
Texte en haut de la page des paiements
</code>
</section>
</page>

255
help/fr/perso_aq.page Normal file
View File

@ -0,0 +1,255 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="perso_aq">
<title>Personnaliser Au Quotidien</title>
<info>
<link type="guide" xref="index" group="4"/>
<desc>Comment personnaliser l'apparence et le comportement d'Au Quotidien</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<section id="param_apparance_aq">
<title>Paramétrer l'apparence d'Au Quotidien</title>
<section id="creer_modifier_theme_graph">
<title>Créer ou modifier un thème graphique</title>
<p>Le thème établit le style général des pages publiques. Un certain nombre de thèmes sont disponibles et définissent
(grâce à l'utilisation de feuilles de style) les éléments de base de la mise en forme des pages publiques. Vous pouvez
définir votre propre thème (avec votre bandeau, votre logo...) si vous avez les compétences requises en matières de
CSS.</p>
<p>Un thème se compose au minimum de deux fichiers : desc.xml et wcs.css. Le ficher desc.xml est un fichier XML
comprenant quelques informations de bases sur le thème : son nom, sa version, son étiquette, sa description, son auteur.
La feuille de style définit les différentes propriétés appliquées aux éléments de chaque page.</p>
<p>Ces deux fichiers doivent être uploader, pour cela allez dans votre espace personnel, <em>Admin</em>,
<em>Paramètres</em> et cliquez sur <em>Thèmes</em> dans la section personnalisation. Cliquez sur <em>Uploader un nouveau
thème :</em>
</p>
<figure>
<media type="image" src="figures/theme_upload.png" />
</figure>
<p>Choisissez dans votre ordinateur votre thème archivé au format .zip.</p>
</section>
<section id="creer_modifier_squelette">
<title>Créer ou modifier le squelette HTML utilisé</title>
<p>Le squelette définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire
qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en modifiant
le squelette utilisé. Les squelettes sont de simples fichiers texte qui contiennent (entre autres choses) un certain
nombre de variables, écrites entre crochets. Ces variables sont remplacées dans la page publique, par la valeur qui leur
a été attribuée. Voici les variables à connaître pour faire des modifications dans le squelette :</p>
<terms>
<item>
<title>title :</title>
<p>Titre de la page affichée en haut de celle-ci</p>
</item>
<item>
<title>site_name :</title>
<p>Nom du site</p>
</item>
<item>
<title>css : </title>
<p>Le nom du fichier contenant la feuille de style</p>
</item>
<item>
<title>script :</title>
<p>Javascripts utilisés par Au quotidien pour certaines fonctionnalités comme le tri des listes</p>
</item>
<item>
<title>onload :</title>
<p>Instructions en javascript déclenchées lors d'un évènement. Cette variable a vocation à être placée comme valeur
de l'attribut onload dans la balise body</p>
</item>
<item>
<title>breadcrumb :</title>
<p>Le fil d'Ariane</p>
</item>
<item>
<title>body :</title>
<p>Contenu principal de la page, habituellement situé entre le titre et le pied de page</p>
</item>
</terms>
<p>Pour modifier le squelette rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Squelette</em>
dans la partie <em>Personnalisation</em>, vous arrivez sur cette page :</p>
<figure>
<media type="image" src="figures/squelette.png" />
</figure>
<p>Le champ contient le code HTML, avec les variables définit ci-dessus, vous permettant d'éditer depuis l'interface
d'administration l'ensemble du squelette. Cliquez sur <em>Valider</em> pour appliquer le nouveau squelette.</p>
<p>Le bouton <em>Restaurer le squelette par défaut</em> vous permet de récupérer le squelette d'origine.</p>
</section>
</section>
<section id="">
<title>Paramétrer les textes et les messages</title>
<section id="envoyer_annonce_utilisateur">
<title>Envoyer des annonces aux utilisateurs</title>
<p>Les annonces sont un moyen de communiquer une information à l'ensemble de vos abonnés par e-mail ou par SMS, ainsi
que de diffuser une copie dans la section <em>Annonces aux citoyens</em> qui ne nécessite aucun abonnement.</p>
<p>Dans votre espace personnel, allez dans <em>Back-office</em>, puis dans <em>Annonces</em> et cliquez sur <em>Nouvelle
Annonce</em>
.</p>
<p>Vous êtes redirigé sur une page vous permettant d'écrire votre nouvelle annonce :</p>
<figure>
<media type="image" src="figures/annonce.png" />
</figure>
<p>Vos devez écrire obligatoirement un
titre et un texte. Vous pouvez choisir une date de publication de votre annonce ou l'envoyer automatiquement en cliquant
sur <em>Valider</em>. Vous pouvez aussi choisir une date d'expiration, date à laquelle l'annonce
disparaîtra de la page
<em>Annonces aux citoyens</em>.</p>
</section>
<section id="perso_texte_affiche">
<title>Personnaliser les textes affichés sur le front-office</title>
<p>L'ensemble des textes présents sur le front-office peuvent être modifiés directement depuis ce dernier en cliquant
sur le bouton <em>Modifier le texte</em> près du texte désiré:</p>
<figure>
<media type="image" src="figures/modifier_texte_frontoffice.png" />
</figure>
<p>Ou en allant dans votre espace personnel en cliquant sur <em>Admin</em>, puis rendez-vous dans <em>Paramètres</em> et
cliquez sur <em>Textes</em> dans la section <em>Personnalisation</em>.</p>
<p>La liste de l'ensemble des textes personnalisables est présente :</p>
<figure>
<media type="image" src="figures/texte_personnalise.png" />
</figure>
<p>Il suffit de cliquer sur le titre du texte que l'on souhaite éditer. Vous êtes redirigé sur une
page comprenant un champ de saisie de texte et de la liste des
<em>Variables de substitution</em>.</p>
</section>
<section id="perso_courriel_envoye">
<title>Personnaliser les courriels envoyés</title>
<p>Les annonces permettent de diffuser à l'ensemble des abonnés (et à ceux qui lisent la section <em>Annonces aux
citoyens</em>
sur la page d'accueil) des messages importants.</p>
<p>Dans votre espace personnel, allez dans <em>Admin</em>, puis dans <em>Paramètres</em> et cliquez sur
<em>Courriels</em> dans la section <em>Personnalisation</em>. Dans <em>Divers</em> cliquez
sur <em>Publication de l'annonce aux abonnés</em>, cette page vous permet de personnaliser la forme de vos annonces
:</p>
<figure>
<media type="image" src="figures/courriels.png" />
</figure>
<p>Ci-dessous sont listés les <em>Variables de substitution</em> qui permettent d'automatiser l'affichage de certains
informations (nom et prénom de l'utilisateur, le nom du site, la date actuelle etc).</p>
<p><em>[title]</em> affichera automatiquement le sujet qui a été rédigé pour l'annonce (voir
<em><link xref="perso_aq#envoyer_annonce_utilisateur">Envoyer des annonces aux utilisateurs</link></em>
),
tout comme <em>[text]</em> affichera le corps du message rédigé. Cela vous permet par exemple de
rajouter une signature en fin de corps, après la variable <em>[text]</em>, afin d'automatiser son affichage sans
intervention humaine.</p>
<p>En cliquant sur <em>Validez</em> vous appliquerez les modifications de la structure de vos annonces.</p>
</section>
<section id="perso_sms_envoye">
<title>Personnaliser les SMS envoyés</title>
<p>Il existe deux types d'envoie d'SMS :</p>
<terms>
<item>
<title>Par annonce</title>
<p>Un SMS sera envoyé au même titre qu'une annonce par e-mail mais dans un format plus court aux abonnés. Des
variables peuvent être utilisées tout comme pour les e-mails (Voir <link xref="#perso_courriel_envoye">Personnaliser les
courriels envoyés</link>
).</p>
</item>
<item>
<title>Par le workflow</title>
<p>Un SMS sera envoyé à l'expéditeur d'une demande. Cela se produit lorsque la demande de l'expéditeur passe dans un
statut où l'envoie d'un SMS a été paramétré.</p>
</item>
</terms>
<p>Pour configurer les options des annonces par SMS rendez-vous dans votre espace personnel, allez dans <em>Admin</em>,
puis dans <em>Panneau de contrôle</em> et cliquez sur <em>Options des annonces</em> :</p>
<figure>
<media type="image" src="figures/option_annonce.png" />
</figure>
<p>L'option <em>Support des SMS</em> permet d'activer ou désactiver les annonces par SMS. Le <em>Masque pour les numéros
de mobiles</em>
indique quel type de numéro sont compatibles pour s'abonner. Pour la France le format à utiliser est
<em>0XXXXXXXXX</em> (comprenant les numéros en 06 et 07).</p>
</section>
<section id="langue">
<title>Configurer la langue du site</title>
<p>Au Quotidien peut être configuré dans toutes les langues. Il suffit de disposer du fichier de
traduction (.po) pour la langue souhaité et l'installé dans Au Quotidien (contactez votre hébergeur web).</p>
<p>Puis, rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et <em>Langue</em>. Une liste déroulante vous
propose de choisir parmis les langues disponibles sur le système.</p>
</section>
<section id="nom_adresse_site">
<title>Configurer le nom et les adresses du site</title>
<p>Il est possible de modifier le nom du site ainsi que son adresse pour l'adapter à vos besoins.</p>
<p>Modifiez le nom à votre guise. Le nom du site apparaît dans la back-office :</p>
<figure>
<media type="image" src="figures/nom_back_office.png" />
</figure>
<p>Et dans le front-office :</p>
<figure>
<media type="image" src="figures/nom_front_office.png" />
</figure>
<p>Les URLs changeront uniquement dans vos mails et lorsqu'il sera donné à l'utilisateur. Il doit être strictement
identique à celui utilisé dans votre navigateur, qui lui est configuré chez l'hébergeur web.</p>
</section>
</section>
</page>

View File

@ -0,0 +1,115 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" id="perso_templates" xml:lang="fr">
<title>2. Mécanique de template</title>
<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>
<link type="guide" xref="index#personnalisation" />
<link type="guide" xref="perso_aq" group="#first" />
</info>
<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>
<section id="creer_modifier_squelette">
<title>Créer ou modifier un squelette</title>
<p>Le squelette définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en modifiant le squelette utilisé. Les squelettes sont de simples fichiers texte qui contiennent (entre autres choses) un certain nombre de variables, écrites entre crochets. Ces variables sont remplacées dans la page publique, par la valeur qui leur a été attribuée. Voici les variables à connaître pour faire des modifications dans le squelette :</p>
<terms>
<item>
<title>title</title>
<p>Titre de la page affichée en haut de celle-ci</p>
</item>
<item>
<title>site_name</title>
<p>Nom du site</p>
</item>
<item>
<title>css</title>
<p>Le nom du fichier contenant la feuille de style</p>
</item>
<item>
<title>script</title>
<p>Javascripts utilisés par Au quotidien pour certaines fonctionnalités comme le tri des listes</p>
</item>
<item>
<title>onload</title>
<p>Instructions en javascript déclenchées lors d'un évènement. Cette variable a vocation à être placée comme valeur de l'attribut onload dans la balise body</p>
</item>
<item>
<title>breadcrumb</title>
<p>Le fil d'Ariane</p>
</item>
<item>
<title>body</title>
<p>Contenu principal de la page, habituellement situé entre le titre et le pied de page</p>
</item>
</terms>
<p>Pour modifier le squelette rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Squelette</em> dans la partie <em>Personnalisation</em>.</p>
<p>Le champ contient le code HTML, avec les variables définit ci-dessus, vous permettant d'éditer depuis l'interface d'administration l'ensemble du squelette. Cliquez sur <em>Valider</em> pour appliquer le nouveau squelette.</p>
<p>Le bouton <em>Restaurer le squelette par défaut</em> vous permet de récupérer le squelette d'origine.</p>
</section>
</page>

24
help/fr/perso_themes.page Normal file
View File

@ -0,0 +1,24 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" id="perso_themes" xml:lang="fr">
<title>3. Themes</title>
<info>
<link type="guide" xref="index#personnalisation" />
<link type="guide" xref="perso_aq" group="#first" />
</info>
<section id="creer_modifier_theme_graph">
<title>Créer ou modifier un thème graphique</title>
<p>Le thème établit le style général des pages publiques. Un certain nombre de thèmes sont disponibles et définissent (grâce à l'utilisation de feuilles de style) les éléments de base de la mise en forme des pages publiques. Vous pouvez définir votre propre thème (avec votre bandeau, votre logo...) si vous avez les compétences requises en matières de CSS.</p>
<p>Un thème se compose au minimum de deux fichiers : desc.xml et wcs.css. Le ficher desc.xml est un fichier XML comprenant quelques informations de bases sur le thème : son nom, sa version, son étiquette, sa description, son auteur. La feuille de style définit les différentes propriétés appliquées aux éléments de chaque page.</p>
<p>Ces deux fichiers doivent être uploader, pour cela allez dans votre espace personnel, <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Thèmes</em> dans la section personnalisation. Cliquez sur <em>Uploader un nouveau thème</em> et choisissez dans votre ordinateur votre thème archivé au format .zip.</p>
</section>
</page>

98
help/fr/roles.page Normal file
View File

@ -0,0 +1,98 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="roles">
<title>2. Rôles</title>
<info>
<link type="guide" xref="utilisateur_role" group="#first" />
<link type="guide" xref="index#utilisateur_et_role" />
</info>
<section id="intro_utilisateur_role">
<title>Introduction</title>
<p>Les rôles sont prépondérants pour deux choses :</p>
<list>
<item><p>Déterminer qui traitera un formulaire</p></item>
<item><p>Déterminer qui pourra compléter un formulaire</p></item>
</list>
<p>Pour les gérer, depuis l'interface d'administration, cliquez sur <em>Rôles</em>.</p>
</section>
<section id="creer_role">
<title>Créer un rôle</title>
<p>Cliquez sur <em>Nouveau rôle</em> :</p>
<figure>
<media type="image" src="figures/role_nouveau.png" />
</figure>
<p>Une fenêtre apparaît pour créer le rôle, vous pouvez attribuer :</p>
<quote>
<terms>
<item>
<title>Nom du rôle</title>
<p>Nom que portera le rôle</p>
</item>
<item>
<title>Détail du rôle</title>
<p>S'il est complété, ce champ donne une information, au niveau du récapitulatif d'une demande, sur le rôle chargé du traitement de celle-ci.</p>
</item>
<item>
<title>Courriels du rôle</title>
<p>Une ou plusieurs adresses e-mail à attribuer au rôle. Lorsque le rôle est destinataire d'un formulaire, les mails envoyés au destinataire, seront envoyés à cette adresse.</p>
</item>
<item>
<title>Propager les courriels à tous les utilisateurs ayant ce rôle</title>
<p>Si cette case est cochée, les mails ne sont plus simplement envoyé à l'adresse courriel du rôle, ils sont aussi envoyés à chaque utilisateur a qui l'on a attribué ce rôle.</p>
</item>
<item>
<title>Les utilisateurs disposant de ce rôle peuvent accéder au back-office</title>
<p>Permet de déterminer si le rôle en question donne accès ou non au backoffice de traitement des demandes. Pour un rôle concernant les citoyens, par exemple « responsable d'une association », on ne cochera pas cette case. Pour un rôle concernant les agents devant traiter les demandes, par exemple « Gestionnaire état civil », on cochera cette case.</p>
</item>
</terms>
</quote>
<p>Validez votre nouveau rôle pourle créer, il apparaît désormais dans la liste.</p>
</section>
<section id="edit_suppr_role">
<title>Éditer / Supprimer un rôle</title>
<p>Cliquez sur le rôle que vous voulez modifier :</p>
<figure>
<media type="image" src="figures/liste_role.png" />
</figure>
<p>Sur la page du rôle vous trouvez les liens <em>Éditer</em>
et <em>Supprimer</em>, permettant respectivement de modifier votre rôle ou de le
supprimer :</p>
<figure>
<media type="image" src="figures/editer_suppr_role.png" />
</figure>
<p>Lors d'une édition vous êtes redirigé sur une page similaire à la
fenêtre de création d'un rôle. Une fois vos changements effectué, validez.
Vous êtes redirigé sur la page du rôle. En cas de suppression vous serez
redirigé vers la listes des rôles.</p>
</section>
<section id="changer_role_form">
<title>Changer les rôles dans un formulaire</title>
<p>Vous pouvez <link xref="form_simple#creer_form">changer le destinataire ou l'expéditeur d'un formulaire</link> en jouant sur les rôles qui lui sont associés.</p>
</section>
</page>

154
help/fr/securite.page Normal file
View File

@ -0,0 +1,154 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="securite">
<title>1. Gestion de la sécurité</title>
<info>
<link type="guide" xref="index#avancee" />
<link type="guide" xref="utilisation_avancee" group="#first" />
</info>
<section id="identification">
<title>Identification</title>
<p>Pour modifier les paramètres d'identification, rendez-vous dans <em>Admin</em>, <em>Paramètres</em>, cliquez sur <em>Identification</em> dans la section <em>Sécurité</em>.</p>
<p>Vous avez deux méthodes d'identification :</p>
<terms>
<item>
<title>Déléguée à un fournisseur d'identités Liberty/SAML2</title>
<p>Permet de déléguer l'identification à un fournisseur d'identité compatible Liberty/SAML2</p>
</item>
<item>
<title>Simplement identifiant / mot de passe local</title>
<p>Méthode d'identification à partir d'un identifiant unique par utilisateur et un mot de passe secret</p>
</item>
</terms>
</section>
<section id="identifiant_mot_de_passe">
<title>Identifiant / mot de passe</title>
<section id="identite">
<title>Identités</title>
<p>Permet de régler les autorisations d'inscription d'utilisateur, les notifications aux administrateurs, la validation d'inscription, l'utilisation du courriel comme identifiant et les délais de notification d'inactivité et la suppression automatique du compte après dépassement d'un délais.</p>
<terms>
<item>
<title>Création d'identités :</title>
<p>Définit la méthode d'inscription au site. Vous pouvez déterminer si l'utilisateur peut s'enregistrer seul, si son inscription doit être validée par un administrateur ou si une inscription ne peut être faite que par un administrateur.</p>
</item>
<item>
<title>Demander une confirmation par courriel pour les nouveaux comptes :</title>
<p>Définit si l'utilisateur doit valider son inscription par e-mail.</p>
</item>
<item>
<title>Notifier les administrateurs lors d'inscriptions :</title>
<p>Un e-mail est envoyé aux administrateurs lors d'une inscription.</p>
</item>
<item>
<title>Utiliser le courriel comme identifiant :</title>
<p>Remplace l'usage d'un pseudonyme par l'adresse e-mail comme identifiant.</p>
</item>
<item>
<title>Avertir des comptes inutilisés après ce nombre de jours :</title>
<p>Un e-mail est envoyé aux administrateurs lorsqu'un compte inactif dépasse le délais en nombre de jour indiqué.</p>
</item>
<item>
<title>Supprimer les comptes inutilisés après ce nombre de jours :</title>
<p>Supprime un compte inactif après le dépassement du délais en jour.</p>
</item>
</terms>
</section>
<section id="mot_de_passe">
<title>Mot de passe</title>
<p>Permet de régler les paramètres d'utilisation d'un mot de passe, la méthode de récupération (mot de passe oublié), sa taille minimale et maximale ainsi que l'algorithme de hashage utilisé pour protéger le mot de passe.</p>
<terms>
<item>
<title>Les utilisateurs peuvent changer leurs mots de passe :</title>
<p>Définit Définit si l'utilisateur peut changer lui-même son mot de passe ou si cela doit être effectué par un administrateur.</p>
</item>
<item>
<title>Générer le mot de passe initial :</title>
<p>Définit si lors de l'inscription l'utilisateur peut choisir son mot de passe ou s'il est généré par Au Quotidien.</p>
</item>
<item>
<title>Comportement en cas de mot de passe perdu :</title>
<p>Définit quelle méthode utilisé lorsqu'un utilisateur a oublié son mot de passe et souhaite le récupérer. <em>Aucun</em> oblige l'utilisateur à contacter un administrateur pour récupérer son mot de passe.</p>
</item>
<item>
<title>Taille minimum des mots de passe :</title>
<p>Définit en nombre de caractère le nombre minimum de caractère d'un mot de passe.</p>
</item>
<item>
<title>Taille maximale des mots de passe :</title>
<p>Définit en nombre de caractère la taille maximum d'un mot de passe.</p>
</item>
<item>
<title>Courriel (pour questions...) :</title>
<p>Définit une adresse e-mail à laquelle l'utilisateur peut répondre lorsqu'il demande une récupération de son mot de passe par e-mail.</p>
</item>
<item>
<title>Algorithme de hashage de mot de passe :</title>
<p>Définit quelle méthode est utilisée pour hasher le mot de passe (le protéger).</p>
</item>
</terms>
</section>
<section id="import_en_masse">
<title>Import en masse</title>
<p>Permet d'importer massivement des comptes utilisateurs depuis un fichier CSV. Ce fichier doit respecter les paramètres suivants :</p>
<terms>
<item>
<title>Encodage :</title>
<p>UTF-8</p>
</item>
<item>
<title>Séparateur de colonnes :</title>
<p>Point-virgule (;)</p>
</item>
<item>
<title>Colonnes :</title>
<p>Mot de passe (vide pour obtenir un mot de passe auto-généré)</p>
<p>Nom</p>
<p>Prénom</p>
<p>courriel</p>
</item>
</terms>
<p>Le bouton d'upload sous <em>Fichier</em> permet de sélectionner le fichier CSV à importer.</p>
<p><em>Envoi d'une notification aux utilisateurs</em> envoie un e-mail aux utilisateurs qui ont été migré depuis un fichier CSV.</p>
<p><em>Rôles</em> permet d'appliquer le rôle choisit de l'ensemble des utilisateurs importés depuis le fichier CSV. Plusieurs rôles peuvent être attribués en même temps.</p>
</section>
</section>
<section id="session">
<title>Session</title>
<p>Les sessions sont attachés à une adresse IP. En cas de changement d'adresse IP, l'utilisateur devra se reconnecter à son compte.</p>
</section>
<section id="certificat">
<title>Certificats</title>
<p>Permet d'ajouter un certificat d'autorité de certification en vue d'utiliser les systèmes de signatures électronique intégré à la solution.</p>
</section>
</page>

View File

@ -0,0 +1,21 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="utilisateur_role">
<title>Utilisateurs et rôles</title>
<info>
<link type="guide" xref="index" group="3"/>
<desc>Comment gérer les utilisateurs et les rôles</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<p>Au Quotidien propose un système basé sur des utilisateurs et des rôles pour utiliser et administrer l'application.</p>
<p>Il est important que chaque personne utilisant Au Quotidien dispose de son propre compte utilisateur. Chaque utilisateur dispose d'un ou de plusieurs rôles qui détermine(nt) ses droits dans l'application.</p>
</page>

254
help/fr/utilisateurs.page Normal file
View File

@ -0,0 +1,254 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="utilisateurs">
<title>1. Utilisateurs</title>
<info>
<link type="guide" xref="utilisateur_role" group="#first" />
<link type="guide" xref="index#utilisateur_et_role" />
</info>
<section id="intro_utilisateur_role">
<title>Introduction</title>
<p>Au Quotidien propose un système basé sur des utilisateurs et des rôles pour utiliser et administrer l'application.</p>
<p>Il est important que chaque personne utilisant Au Quotidien dispose de son propre compte utilisateur. Chaque utilisateur fait partie d'un ou plusieurs rôles qui gèrent les permissions de chacun.</p>
<p>Les rôles sont utilisés pour deux aspects différents :</p>
<list>
<item><p>Déterminer qui recevra et gérera un type donné de formulaire</p></item>
<item><p>Déterminer qui pourra compléter un type donné de formulaire</p></item>
</list>
</section>
<section id="creer_admin">
<title>Création initiale d'un administrateur</title>
<note>
<p>Cette partie ne vous concerne que si vous avez procédé vous-même à
l'installation de w.c.s, dans le cas contraire votre prestataire a
du s'en charger pour vous.</p>
</note>
<p>L'administrateur est l'utilisateur ayant le plus de droits au sein
d'Au Quotidien, il a accès à la partie <em>Admin</em>. Il peut gérer les
formulaires, les workflows, les utilisateurs, les rôles et changer les
paramètres d'Au Quotidien.</p>
<p>C'est donc l'utilisateur le plus important et il est primordial que son
accès soit restreint à une personne, désigné comme responsable, avec un bon
mot de passe.</p>
<p>Une fois w.c.s installé, vous devez ajouter cette utilisateur
manuellement sur cette page :</p>
<figure>
<media type="image" src="figures/ajouter_admin.png" />
</figure>
<terms>
<item>
<title>Méthodes :</title>
<p>Sélection de la méthode d'authentification de l'administrateur</p>
</item>
<item>
<title>Association à sens unique entre un utilisateur et ses
formulaire :</title>
<p></p>
</item>
</terms>
</section>
<section id="utilisateur">
<title>Les utilisateurs</title>
<p>Dans votre espace personnel, allez dans <em>Admin</em> puis
dans <em>Utilisateurs</em>.</p>
<section id="creer_utilisateur">
<title>Créer un utilisateur</title>
<p>Cliquez sur <em>Nouvel utilisateur</em> :</p>
<figure>
<media type="image" src="figures/utilisateur_nouveau.png" />
</figure>
<p>Vous êtes redirigé sur un formulaire de création, il vous permet
d'attribuer :</p>
<quote>
<terms>
<item>
<title>Nom</title>
</item>
<item>
<title>Prénom</title>
</item>
<item>
<title>Courriel</title>
<p>L'adresse e-mail de l'utilisateur</p>
</item>
<item>
<title>Compte administrateur</title>
<p>Déterminer s'il sera administrateur</p>
</item>
<item>
<title>Rôles</title>
<p>Un ou plusieurs rôles</p>
</item>
<item>
<title>Identifiant</title>
<p>Le nom du compte</p>
</item>
<item>
<title>Mot de passe</title>
</item>
</terms>
</quote>
<p>Vous pouvez aussi cocher :</p>
<quote>
<terms>
<item>
<title>En attente de confirmation</title>
<p>Une personne sera chargé de valider le compte</p>
</item>
<item>
<title>En attente de modération</title>
<p>Un modérateur sera chargé de valider le compte</p>
</item>
<item>
<title>Compte désactivé</title>
<p>Désactiver le compte au lieu de le supprimer, l'accès y est impossible et tout ce qui concerne l'utilisateur est conservé.</p>
</item>
</terms>
</quote>
<p>Une fois complété, validez. Vous êtes redirigé vers la page
des <em>Utilisateurs</em> où l'utilisateur est désormais listé.</p>
</section>
<section id="editer_suppr_utilisateur">
<title>Éditer / Supprimer un utilisateur</title>
<p>Cliquez sur le nom de l'utilisateur dans la liste :</p>
<figure>
<media type="image" src="figures/liste_utilisateur.png" />
</figure>
<p>Vous êtes redirigé vers sa page, vous avez les liens <em>Éditer</em>
et <em>Supprimer</em> qui respectivement vous permettent de modifier ou
supprimer votre utilisateur :</p>
<figure>
<media type="image" src="figures/utilisateur_lien_edition_suppr.png" />
</figure>
<p>Après l'édition d'un utilisateur vous serez redirigé sur sa page. Après
une suppression vous serez redirigé sur la page <em>Utilisateurs</em>.</p>
<p>Notez qu'il peut être intéressant de désactiver un compte au lieu de le
supprimer en l'éditant. Cela vous permet d'empêcher un utilisateur de se
connecter sans pour autant supprimer son compte avec ses accès et ses
données.</p>
</section>
</section>
<section id="role">
<title>Les rôles</title>
<p>Dans votre espace personnel, allez dans <em>Admin</em> puis dans <em>Rôles</em>.</p>
<section id="creer_role">
<title>Créer un rôle</title>
<p>Cliquez sur <em>Nouveau rôle</em> :</p>
<figure>
<media type="image" src="figures/role_nouveau.png" />
</figure>
<p>Une fenêtre apparaît pour créer le rôle, vous pouvez attribuer:</p>
<quote>
<terms>
<item>
<title>Nom du rôle</title>
<p>Celui que portera le rôle</p>
</item>
<item>
<title>Détail du rôle</title>
<p>Ce sont des informations complémentaires à propos du rôle</p>
</item>
<item>
<title>Courriels du rôle</title>
<p>Une ou plusieurs adresses e-mail à attribuer au rôle</p>
</item>
<item>
<title>Propager les courriels à tous les utilisateurs ayant ce rôle</title>
<p>En cochant la case vous transférerez chaque e-mail au rôle à ses utilisateurs sur leur adresse e-mail.</p>
</item>
<item>
<title>Les utilisateurs disposant de ce rôle peuvent accéder au back-office</title>
<p>Une autorisation d'accéder au back-office à tous les utilisateurs ayant ce rôle</p>
</item>
</terms>
</quote>
<p>Validez, votre nouveau rôle est désormais dans la liste.</p>
</section>
<section id="edit_suppr_role">
<title>Éditer / Supprimer un rôle</title>
<p>Cliquez sur le rôle que vous voulez modifier :</p>
<figure>
<media type="image" src="figures/liste_role.png" />
</figure>
<p>Puis, sur la page du rôle vous avez les liens <em>Éditer</em>
et <em>Supprimer</em>, permettant respectivement de modifier votre rôle ou le
supprimer :</p>
<figure>
<media type="image" src="figures/editer_suppr_role.png" />
</figure>
<p>Lors d'une édition vous êtes redirigé sur une une page similaire à la
fenêtre de création d'un rôle. Une fois vos changements effectué, validez.
Vous êtes redirigé sur la page du rôle. En cas de suppression vous serez
redirigé vers la page <em>Rôles</em>.</p>
</section>
<section id="changer_role_form">
<title>Changer le rôle d'un formulaire</title>
<p>Pour changer le rôle d'un formulaire, rendez-vous sur la page du formulaire
et cliquez sur <em>(changer)</em> à la ligne <em>Rôle du destinataire</em> dans
la partie <em>Accès</em> :</p>
<figure>
<media type="image" src="figures/form_changer_role.png" />
</figure>
<p>Sélectionnez le nouveau rôle et validez.</p>
</section>
</section>
</page>

View File

@ -0,0 +1,18 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="utilisation_avancee">
<title>Utilisation avancée</title>
<info>
<link type="guide" xref="index" group="5"/>
<desc>Comment gérer les utilisateurs et les rôles</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
</page>

40
help/fr/workflows.page Normal file
View File

@ -0,0 +1,40 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="workflows">
<title>Workflows</title>
<info>
<link type="guide" xref="index" group="2"/>
<desc>Comment utiliser les workflows</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<section id="def_workflow">
<title>Définition</title>
<p>Chaque demande d'un usager est envoyé dans un circuit de traitement qui commence à l'arrivée de la demande dans le service destinataire jusqu'à son traitement (élaboration d'un document, réponse à la demande, interventions, etc.). C'est ce circuit qui est appelé workflow et qui est entièrement paramétrable dans Au quotidien et peut-être différent pour chaque formulaire. Le workflow définit donc comment, où et qui traite la demande.</p>
</section>
<section id="workflow_aq">
<title>Comment fonctionnent les workflows d'Au Quotidien</title>
<p>Même si tout est paramétrable, certains principes sont communs à la quasi-totalité des workflows. Lorsqu'une demande est envoyée, Au Quotidien alerte par e-mail le demandeur (pour lui confirmer la réception de sa demande) et le destinataire (c'est-à-dire le ou les responsable(s) chargé(s) de traiter la demande). Une série de <link xref="workflows_statuts">statuts</link> (étapes) se succèdent alors chacun regroupant un certain nombre d'<link xref="workflows_actions">actions</link>.</p>
<p>Ces <link xref="workflows_statuts">statuts</link> et ces <link xref="workflows_actions">actions</link> sont définies dans le workflow et guide les différents intervenants (demandeur, destinataire mais aussi des tiers parfois) vers le traitement final de la demande. Le workflow peut faire changer le destinataire de la demande, permet de demander une validation, d'élaborer un document selon un template prédéfini, etc.</p>
<p>Au Quotidien fournit une série de workflow existants, mais il est possible d'en <link xref="workflows_gerer#creer_workflow_depuis_zero">créer de nouveau</link>, de les <link xref="workflows_gerer#import_export_workflow">importer et exporter</link> .</p>
</section>
</page>

View File

@ -0,0 +1,285 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_actions">
<title>5. Les actions de workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<p>Les actions sont les éléments de base que l'on combine au sein d'un <link xref="workflows_statuts">statut</link> pour déterminer ce qui va se passer lorsqu'une demande atteint le statut en question.</p>
<p>Les actions permettent notamment d'envoyer des mails/sms à différentes personnes, de changer le destinaire de la demande, de dialoguer avec le demandeur, de modifier la demande, de créer un document à partir de la demande, de communiquer avec des webservices, de changer de statut... </p>
<section id="ajouter-action">
<title>Ajouter une action</title>
<p>Pour ajouter une action à un statut vous cliquez sur le statut en question, vous choisissez une action dans la liste déroulante et vous cliquez sur ajouter :</p>
<figure>
<media type="image" src="figures/ajouter_action.png" />
</figure>
</section>
<section id="editer-action">
<title>Éditer une action</title>
<p>Pour éditer une action, vous cliquez sur le lien éditer qui apparaît au survol de l'action :</p>
<figure>
<media type="image" src="figures/editer_action.png" />
</figure>
</section>
<section id="supprimer-action">
<title>Supprimer une action</title>
<p>Pour supprimer une action, vous cliquez sur le lien supprimer qui apparaît au survol de l'action :</p>
<figure>
<media type="image" src="figures/supprimer_action.png" />
</figure>
</section>
<section id="types">
<title>Les différents types d'action</title>
<section id="afficher_formulaire">
<title></title>
<p>
Lors du traitement d'une demande il peut être nécessaire de demander des informations supplémentaires à l'usager, ou qu'un agent complète la demande avec des informations internes (à l'image d'un « cadre réservé à l'administration » sur du papier). C'est
</p>
<p>L'action « Afficher un formulaire » permet d'afficher des champs de formulaire supplémentaires (tous les champs w.c.s. sont disponibles) à un rôle particulier : demandeur (expéditeur), destinataire (gestionnaire de la demande) ou n'importe quel autre rôle utilisé dans w.c.s..</p>
<figure>
<title>Afficher un formulaire</title>
<media type="image" src="afficher_formulaire.png" />
</figure>
<p>Lors de l'édition de cette action vous choisissez le rôle concerné, vous donnez un nom au formulaire ( « Nom de variable »), puis vous cliquez sur « Éditer les champs » pour ajouter les champs souhaités. L'ajout se fait exactemment comme pour un <link xref="form_simple">formulaire classique</link> de w.c.s., vous ajoutez autant de champs que vous le souhaitez, vous validez, le formulaire est créé au sein du statut concerné.</p>
<note style="important"><p>
Il est important de préciser un <gui>Nom de variable</gui> pour que la valeur qui sera renseignée par le champ soit sauvegardée.
</p></note>
</section>
<section id="afficher_message">
<title>Afficher un message</title>
<p>Cette action permet d'afficher un message au demandeur lorsqu'il a validé sa demande. Dans le texte du message vous pouvez introduire du code html ainsi qu'un certain nombre de <link xref="workflows_variables">variables</link> prédéfinies (rappelées sous la fenêtre de texte).</p>
<figure>
<title>Afficher un message</title>
<media type="image" src="afficher_message.png" />
</figure>
</section>
<section id="message_recapitulatif">
<title>Agréger dans un message de récapitulatif</title>
<p>Ce statut permet d'envoyer quotidiennement à un gestionnaire la liste des demandes qui sont dans le statut concerné. Par exemple, on pourra envoyé chaque matin à l'agent en charge du trairement un mail rappellant toutes les demandes ayant le statut "en attente de traitement".</p>
<figure>
<title>Message de récapitulatif</title>
<media type="image" src="message_recapitulatif.png" />
</figure>
</section>
<section id="ajouter_role_expediteur">
<title>Ajouter un rôle à l'expéditeur</title>
<p>Si l'on souhaite que le demandeur se voit attribué un rôle particulier dans le statu concerné, on lui ajouter ce rôle avec cette action. Le rôle vient s'aditionner aux rôles existant pour le demandeur, pas s'y substituer.</p>
<figure>
<title>Ajouter un rôle à l'expéditeur</title>
<media type="image" src="ajouter_role_expediteur.png" />
</figure>
</section>
<section id="webservice">
<title>Appeler un webservice</title>
<p>Cette action permet de lier w.c.s. à une application tierce grâce à la saisie d'une URL web services :</p>
<figure>
<title>Appeler un webservice</title>
<media type="image" src="webservice.png" />
</figure>
<p>L'URL peut contenir un certain nombre de <link xref="workflows_variables">variables</link> prédéfinies (rappelées sous la fenêtre de texte).</p>
<p>Il faut également donner un nom à l'action ( « Nom de variable ») et préciser FIXME : Envoyer le formulaire (POST, en JSON)</p>
</section>
<section id="attribuer_fonction">
<title>Attribuer une fonction</title>
<p>Cette action permet d'attribuer la fonction de destinataire ou d'expéditeur à un rôle particulier. Il peut par exemple s'avérer utile de changer le destinataire de la demande en cours de route lorsque le destinataire initial n'est pas finalement celui qui doit traiter la demande.</p>
<figure>
<title>Attribuer une fonction</title>
<media type="image" src="attribuer_fonction.png" />
</figure>
</section>
<section id="changer_statut">
<title>Changer de statut</title>
<p>Vous pouvez par ce biais définir les actions possibles pour la personne en charge du traitement du formulaire : accepté, refusé, transmis, etc.. Ces éléments correspondent aux boutons d'actions mis à disposition des gestionnaires pour traiter les demandes.</p>
<p>Il vous faut définir l'intitulé du bouton pour la personne en charge du traitement, puis le statut associé, enfin les rôles pouvant interagir avec ce bouton.</p>
<figure>
<title>Changer de statut</title>
<media type="image" src="changer_statut.png" />
</figure>
</section>
<section id="changer_statut_automatique">
<title>Changer de statut automatiquement</title>
<p>Le changement de statut automatique vous permet de rediriger automatiquement une demande suite à l'exécution d'une série d'actions (envoi de courriels, validation d'un paiement...). Cet élément peut également être conditionné en fonction de la saisie de l'utilisateur. Ainsi, suivant le choix de l'usager dans une liste déroulante, il vous sera possible de rediriger la demande vers une étape de statut prédéterminée.</p>
<figure>
<title>Changer de statut automatiquement</title>
<media type="image" src="changer_statut_automatique.png" />
</figure>
<p>Un formulaire de demande de contact proposant une liste de services de la collectivité pourrait être la source de la condition. En fonction du choix de l'usager (services technique, accueil, service communication...), la demande est redirigée directement vers le bon interlocuteur.</p>
<p>Par exemple pour rediriger vers le statut "demande en cours auprès du service communication", la condition sera la suivante: <code>var_choixService=="service communication"</code></p>
<p>FIXME : Déclencheur ?</p>
<p>Après expiration : Cet élément vous permet de définir un délai de prise en charge à l'issu duquel (sans intervention sur la demande) la demande est redirigée sur un autre statut, pour une relance auprès des services par exemple.</p>
</section>
<section id="changer_statut_soumission">
<title>Changer de statut à la soumission</title>
<p>Cette fonction permet de basculer automatiquement vers un statut après avoir ajouté un commentaire et cliqué sur l'action "ajouter un commentaire" (voir l'élément <link xref="#workflow_commentaire">permettre un commentaire</link>).</p>
<figure>
<title>Changer de statut à la soumission</title>
<media type="image" src="changer_statut_soumission.png" />
</figure>
</section>
<section id="workflow_document">
<title>Créer un document</title>
<p>Il peut-être utile de créer un document à partir d'une demande, c'est possible avec cette action.</p>
<figure>
<title>Créer un document</title>
<media type="image" src="workflow_document.png" />
</figure>
<p>Il suffit de choisir un libellé pour le bouton affiché au destinataire pour lui permettre de générer ce document et de faire un modèle de document au format RTF. Ce modèle peut contenir un certain nombre de <link xref="workflows_variables">variables</link> prédéfinies (rappelées sous la fenêtre de texte).</p>
</section>
<section id="enregistrer_journal">
<title>Enregistrer dans le journal</title>
<p>Cette action permet de saisir un commentaire qui sera affiché dans le journal, c'est à dire dans l'historique de la demande, aussi bien pour le demandeur que pour le destinataire.</p>
<figure>
<title>Enregistrer dans le journal</title>
<media type="image" src="enregistrer_journal.png" />
</figure>
</section>
<section id="sms_email">
<title>Envoyer un SMS / Envoyer un mail</title>
<p>Il est possible d'envoyer des SMS et des courriels automatiquement. Ces messages disposent d'une liste de <link xref="workflows_variables">variables</link> permettant d'appeler les détails de la demande ou/et de l'usager afin de personnaliser les messages (rappelées sous la fenêtre de texte).</p>
<p>Ces messages peuvent être des courriels ou des SMS (pour les plateformes disposant d'un abonnement SMS)</p>.
<figure>
<title>Envoyer un SMS / Envoyer un mail</title>
<media type="image" src="sms_email.png" />
</figure>
</section>
<section id="workflow_joindre_fichier">
<title>Permettre de joindre un fichier</title>
<p>L'action permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.), de pouvoir ajouter un fichier à la demande</p>
<p>On peut définir un titre (s'affichant avant le bouton de téléchargement), le libellé du bouton, une remarque s'affichant juste en dessous du bouton, ainsi que le caractère obligatoire ou facultatif du champ :</p>
<figure>
<title>Permettre de joindre un fichier</title>
<media type="image" src="workflow_joindre_fichier.png" />
</figure>
</section>
<section id="workflow_edition">
<title>Permettre l'édition</title>
<p>Cette fonction permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) d'éditer, donc de modifier un formulaire une fois validé. Elle peut servir par exemple en cas de consultation à pouvoir changer d'avis dans le temps.</p>
<figure>
<title>Permettre l'édition</title>
<media type="image" src="workflow_edition.png" />
</figure>
</section>
<section id="workflow_commentaire">
<title>Permettre un commentaire</title>
<p>Cette fonction permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) de commenter le formulaire. Cela est fréquemment utilisé pour permettre un premier échange entre expéditeur et destinataire concernant la demande : on crée alors une action « Permettre un commentaire » avec 2 rôles, expéditeur et destinataire.</p>
<figure>
<title>Permettre un commentaire</title>
<media type="image" src="workflow_commentaire.png" />
</figure>
</section>
<section id="workflow_redirection">
<title>Redirection vers la page d'état</title>
<p>Permet directement la page d'état du formulaire au lieu du récapitulatif (après la complétion d'une demande). On peut également s'en servir pour afficher la page d'état du back-office, mais pour pouvoir la visualiser, il faut bien entendu que l'utilisateur ait les droits d'accès au backoffice.</p>
<figure>
<title>Redirection vers la page d'état</title>
<media type="image" src="workflow_redirection.png" />
</figure>
</section>
<section id="workflow_supprimer_formulaire">
<title>Supprimer le formulaire</title>
<p>Cette action permet de supprimer le formulaire, par exemple lorsque la demande est traitée si on ne souhaite pas l'archiver.</p>
<figure>
<title>Supprimer le formulaire</title>
<media type="image" src="workflow_supprimer_formulaire.png" />
</figure>
</section>
<section id="wokflow_supprimer_role">
<title>Supprimer un rôle de l'expéditeur</title>
<p>Cette action permet de supprimer un rôle dont dispose l'expéditeur. Par exemple si le formulaire concerne une résiliation, on va, en fin de traitement, enlever le rôle « Abonné » au demandeur.</p>
<figure>
<title>Supprimer un rôle de l'expéditeur</title>
<media type="image" src="wokflow_supprimer_role.png" />
</figure>
</section>
</section>
</page>

View File

@ -0,0 +1,52 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_defaut">
<title>1. Le workflow par défaut</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<section id="inamovible">
<title>Toujours installé</title>
<p>Le workflow par défaut est le seul installé systématiquement dans toutes les instances d'Au Quotidien. Il n'est pas éditable ou supprimable, vous pouvez le dupliquer pour l'adapter à vos besoins ou l'exporter.</p>
</section>
<section id="statuts">
<title>Les statuts</title>
<p>Il contient les <link xref="workflows_status">statuts</link> suivants :</p>
<terms>
<item>
<title>Juste envoyé</title>
<p>La demande a été envoyée par l'expéditeur et n'a pas encore été traité, une copie de la demande est envoyée par e-mail au destinataire et à l'expéditeur, le statut change alors automatiquement pour basculer vers le statut <em>Nouveau</em>.</p>
</item>
<item>
<title>Nouveau</title>
<p> Le destinataire et l'expéditeur peuvent laisser un commentaire (à plusieurs reprise, cela leur permet d'échanger, de préciser la demande). Le destinataire choisit ensuite d'accepter la demande (ce qui la fait passer au statut accepté) ou la refuser (ce qui la fait passer au statut Rejeté).</p>
</item>
<item>
<title>Rejeté</title>
<p>La demande a été refusée par le destinataire. Un e-mail est envoyé au destinataire et à l'expéditeur. La démarche est terminée.</p>
</item>
<item>
<title>Accepté</title>
<p>La demande a été acceptée par le destinataire. Un e-mail est envoyé au destinataire et à l'expéditeur. Tous deux peuvent laisser un commentaire sur la demande. Le destinataire peut passer la demande au statut Terminé.</p>
</item>
<item>
<title>Terminé</title>
<p>Un e-mail est envoyé au destinataire et à l'expéditeur. La demande est close.</p>
</item>
</terms>
</section>
</page>

View File

@ -0,0 +1,40 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_form">
<title>3. Attribuer un nouveau workflow à un formulaire</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<p>Associer un nouveau workflow à un formulaire est relativement simple si le formulaire n'est pas en production, mais cela peut s'avérer plus périlleux si le formulaire est réellement utilisé, surtout si les <link xref="workflows_statuts">statuts</link> entre l'ancien et le nouveau workflow ne sont pas tout à fait identiques.</p>
<title>Changement simple</title>
<figure>
<media type="image" src="figures/.png" />
</figure>
<steps>
<item><p>Depuis l'interface d'administration cliquez sur le formulaire dont vous voulez changer le workflow.</p></item>
<item><p>Dans la rubrique « Accès » Cliquez sur le lien « changer » en face de Workflow.</p></item>
<item><p>Sélectionnez le workflow désiré dans la liste déroulante et validez.</p></item>
</steps>
<p>Vous avez alors la possibilité d'associer les statuts de l'ancien workflow et ceux du nouveau. Lorsque les deux workflows comportent les mêmes statuts, il suffit de les faire correspondre un à un. Lorsque les statuts sont différents, il vous faut réfléchir à le meilleure façon d'établier la correspondance.</p>
<p>Lorsque des demandes sont en cours et que vous changez le workflow vous devez vous assurer qu'il n'y aura pas de conflits (une demande pourrait être dans un état (statut) non existant dans le nouveau workflow).</p>
<figure>
<media type="image" src="figures/verification_conflit_changement_workflow.png" />
</figure>
<note style="important">
<title>Dupliquez le formulaire s'il est en production</title>
<p>Concernant les formulaires en production, il est déconseillé de changer le workflow sans tester préalablement. Il est préférable de dupliquer le formulaire original, d'appliquer le nouveau workflow sur la copie et de vérifier que tout est en ordre.</p>
</note>
</page>

View File

@ -0,0 +1,180 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_gerer">
<title>2. Gérer les workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<note style="important">
<title>Associer un workflow à un formulaire</title>
<p>La façon dont on associe un workflow à un formulaire est traitée <link xref="workflows_form">ailleurs</link></p>
</note>
<section id="creer_workflow">
<title>Créer un workflow</title>
<p>Lorsque le workflow par défaut ne convient pas à votre formulaire, vous devez créer un workflow personnalisé et l'adapter à votre besoin.</p>
<note style="advanced">
<title>Basez-vous sur un autre workflow de préférence</title>
<p>Nous allons décrire comment créer entièrement un workflow, mais il est souvent préférable, en particulier quand on débute, de <link xref="#creer_workflow_depuis_modele">s'appuyer sur un workflow existant</link>. Cela facilite la compréhension des mécanismes.</p>
</note>
<section id="creer_workflow_ex_nihilo">
<title>Créer un workflow ex nihilo</title>
<p>Dans l'interface d'administration, cliquez sur <em>Workflow</em> puis sur <em>Nouveau workflow</em> :</p>
<figure>
<media type="image" src="figures/workflow_lien_nouveau.png" />
</figure>
<p>Attribuez un nom au workflow et validez, vous êtes redirigé sur la page d'édition du workflow. Pour ajouter un statut, attribuez-lui un nom dans le menu <em>Nouveau statut</em> à droite :</p>
<figure>
<media type="image" src="figures/workflow_nouveau_statut.png" />
</figure>
<note style="advanced">
<title>Statuts</title>
<p>Pour en savoir plus, vous pouvez consulter la page consacrée aux <link xref="workflows_statuts">statuts</link></p>
</note>
<p>Une fois ajouté, votre statut apparaît sous deux formes :</p>
<list>
<item><p>Dans une liste :</p></item>
</list>
<figure>
<media type="image" src="figures/liste_statut.png" />
</figure>
<list>
<item><p>Dans un schéma :</p></item>
</list>
<figure>
<media type="image" src="figures/schema_statut.png" />
</figure>
<p>En cliquant sur le statut dans la liste ou sur le plan en image vous êtes redirigé sur la page d'édition du statut.</p>
<p>Pour ajouter un élément vous devez dans le menu <em>Nouvel élément</em> à droite choisir un type et cliquer sur <em>Ajouter</em> :</p>
<figure>
<media type="image" src="figures/workflow_ajout_element_statut.png" />
</figure>
<p>De la même manière que pour le statut, l'élément apparaît dans la liste et dans le schéma de la page du statut :</p>
<figure>
<media type="image" src="figures//nouvel_element_liste_schema.png" />
</figure>
<p>Vous pouvez cliquer sur l'élément dans le schéma ou dans la liste pour l'éditer.</p>
<note style="advanced">
<title>Statuts et Actions</title>
<p>Dirigez-vous vers les pages consacrées aux <link xref="workflows_statuts">statuts</link> et aux <link xref="workflows_actions">actions</link> pour comprendre leur fonctionnement.</p>
</note>
</section>
<section id="creer_workflow_depuis_modele">
<title>Créer un workflow à partir d'un autre workflow</title>
<p>Partir d'un autre workflow est la solution recommandée pour en créer un nouveau. Il faut commencer par dupliquer un workflow existant, puis le modifier.</p>
<section id="dupliquer_workflow">
<title>Dupliquer un workflow existant</title>
<p>Nous prendrons l'exemple de la duplication du workflow par défaut même si l'opération peut-être réalisée avec n'importe quel workflow.</p>
<p> Depuis l'interface d'administration, cliquez sur <em>Workflow</em> et cliquez sur le workflow <em>Par défaut</em>.</p>
<p>Cliquez sur <em>Dupliquer</em> à droite :</p>
<figure>
<media type="image" src="figures/workflow_dupliquer_defaut.png" />
</figure>
<p>Un nouveau workflow est créé, nommé <em>Par défaut (copie)</em>, vous êtes redirigé sur sa page.</p>
</section>
<section id="modifier_copie_workflow">
<title>Modifier la copie du workflow</title>
<p>Cliquez sur <em>Changer le titre</em>, dans le champ <em>Nom du workflow</em> remplacez <em>Par défaut (copie)</em> par le titre de votre choix et validez :</p>
<figure>
<media type="image" src="figures/workflow_lien_changer_titre.png" />
</figure>
<p>Vous êtes redirigé dans le menu <em>Workflow</em>, vous pouvez maintenant éditer et modifier les statuts de ce workflows, les supprimer ou en ajouter de nouveaux.</p>
<note style="advanced">
<title>Statuts et Actions</title>
<p>Dirigez-vous vers les pages consacrées aux <link xref="workflows_statuts">statuts</link> et aux <link xref="workflows_actions">actions</link> pour comprendre leur fonctionnement.</p>
</note>
</section>
</section>
</section>
<section id="import_export_workflow">
<title>Comment importer / exporter un workflow</title>
<section id="import_workflow">
<title>Importer un workflow</title>
<p>Depuis l'interface d'administration, cliquez sur <em>Import</em>, vous pouvez alors choisir un fichier sur votre disque, une clé ou le réseau.</p>
<figure>
<media type="image" src="figures/workflow_lien_import.png" />
</figure>
<p>Sélectionnez le fichier .wcs qui contient le workflow et confirmez, le workflow est importé.</p>
<note style="warning">
<title>Rôles à vérifier</title>
<p>Certains rôles du workflow importé peuvent ne pas exister dans votre solution. Il vous faudra alors modifier le workflow manuellement pour le faire correspondre aux rôles existant dans votre application.</p>
</note>
</section>
<section id="export_workflow">
<title>Exporter un workflow</title>
<p>Cliquez sur le workflow que vous souhaitez exporter, puis dans le menu à droite cliquez sur <em>Export</em> et enregistrez-le dans un fichier .wcs (l'extension est positionnée automatiquement) :</p>
<figure>
<media type="image" src="figures/workflow_lien_export.png" />
</figure>
<p>Le workflow est exporté, prêt à être importé dans une autre instance de Au quotidien ou déposé sur le site communautaire.</p>
</section>
</section>
<section id="suppr_workflow">
<title>Comment supprimer un workflow</title>
<p>Depuis l'interface d'administration, allez dans <em>Workflow</em> et cliquez sur le workflow que vous souhaitez supprimer. Puis cliquez sur <em>Supprimer</em> dans le menu à droite et validez :</p>
<figure>
<media type="image" src="figures/workflow_lien_suppr.png" />
</figure>
</section>
</page>

View File

@ -0,0 +1,66 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_statuts">
<title>4. Les statuts de workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<section id="general">
<title>Généralités</title>
<p>Un workflow est un ensemble d'étapes, les statuts, par lesquelles passe le formulaire. Ces statuts regroupent eux-mêmes une série d'<link xref="workflows_actions">actions</link> permettant d'interragir avec la demande, les utilisateurs et de changer de statut.</p>
</section>
<section id="creer">
<title>Creer un statut</title>
<p>Pour créer un nouveau statut lorsqu'on se trouve sur un workflow donné, il faut lui donner un nom et cliquer sur valider.</p>
<figure>
<media type="image" src="figures/creer_statut.png" />
</figure>
</section>
<section id="ajouter">
<title>Ajouter des actions à un statut</title>
<p>Tant qu'il est vide, un statut n'a aucune utilité. Il faut l'alimenter avec des <link xref="workflows_actions">actions</link> de différents types, ce sont ces actions mises bout à bout qui vont définir ce qui se passe lorsque une demande est dans un statut donné.</p>
<p>Vous éditez un statut en cliquant sur son nom dans la liste ou sur le schéma, vous pouvez alors lui ajouter les actions qui se trouvent dans la liste déroulante à droite.</p>
<figure>
<media type="image" src="figures/liste_actions_workflow.png" />
</figure>
</section>
<section id="creer">
<title>Supprimer un statut</title>
<p>Pour supprimer un statut, il suffit de cliquer sur le lien « Supprimer ». Toutes les actions qu'il contenait sont alors effacées.</p>
<figure>
<media type="image" src="figures/supprimer_statut.png" />
</figure>
</section>
<section id="Options">
<title>Options des statuts</title>
<p>Tous les statuts dispose des mêmes options :</p>
<figure>
<media type="image" src="figures/creer_workflow.png" />
</figure>
<p>Ces options permettent de :</p>
<list>
<item><p>Changer le nom du statut. Il faut noter que ce nom apparaît pour le citoyen d'une part et pour le gestionnaire du formulaire (le destinataire) d'autre part.</p></item>
<item><p>Changer la visibilité du statut. Cela permet de faire en sorte qu'un statut soit "privé", c'est à dire qu'il soit réservé au backoffice (au destinataire) et n'apparaissent pas au demandeur.</p></item>
<item><p>Changer le caractère final du statut. Par défaut, un statut a un caractère final s'il ne peut déboucher sur aucun autre statut. Il est parfois nécessaire de dire qu'un statut est final même si il peut déboucher sur d'autres statuts. C'est possible grâce à cette option.</p></item>
</list>
</section>
</page>

View File

@ -0,0 +1,109 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="workflows_variables">
<title>6. Les variables utilisables</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
</info>
<section id="generalites">
<title>Généralités</title>
<p>Les variables sont des éléments prédéfinis permettant d'appeler les détails de la demande ou/et de l'usager afin de personnaliser les messages. Une variable mise dans un modèle de message sera remplacée dans le message reçu par l'utilisateur par son contenu : le nom de la personne, le lien vers sa demande, etc..</p>
<p>Les variables système disponibles sont de quatre types : les variables liées au formulaire, les variables liées au site, les variables liées au catégories et les variables liées à la session de l'utilisateur en cours.</p>
<p>Les variables disponibles pour chaque type d'<link xref="workflows_actions">action</link> sont rappelées sur l'écran d'édition des actions</p>
<p>En plus des variables système, vous pouvez utiliser des <link xref="#variables_specifiques">variables spécifiques à un formulaire</link>.</p>
<note style="important">
<title>Toujours entre crochets</title>
<p>Dans le corps du modèle de message, les variables doivent toujours impérativement être mise entre crochets : <code>[nom_de_la_variable]</code></p>
</note>
<note style="advanced">
<title>Utiliser les variables dans les thèmes</title>
<p>Les variables sont également accessibles dans les <link xref="perso_themes">thèmes</link> et les <link xref="perso_templates">templates</link>, pour le préremplissage des champs par exemple.</p>
</note>
</section>
<section id="variables_formulaire">
<title>Variables système liées au formulaire</title>
<list>
<item><p><code>[form_details]</code> : L'ensemble des données du formulaire</p></item>
<item><p><code>[form_name]</code> : Nom du formulaire</p></item>
<item><p><code>[form_number]</code> : Numéro du formulaire</p></item>
<item><p><code>[form_receipt_date]</code> : Date de réception du formulaire</p></item>
<item><p><code>[form_receipt_time]</code> : Heure de réception du formulaire</p></item>
<item><p><code>[form_evolution]</code> : L'ensemble de l'historique du traitement</p></item>
<item><p><code>[form_status]</code> : Statut actuel du formulaire</p></item>
<item><p><code>[form_previous_status]</code> : Statut précédent du formulaire</p></item>
<item><p><code>[form_status_changed]</code> : Un booléen précisant que le formulaire vient de changer de statut</p></item>
<item><p><code>[form_status_url]</code> : URL du statut du formulaire</p></item>
<item><p><code>[form_uri]</code> : URI du formulaire</p></item>
<item><p><code>[form_url]</code> : URL du formulaire</p></item>
<item><p><code>[form_url_backoffice]</code> : L'adresse du backoffice du formulaire</p></item>
<item><p><code>[form_number]</code> : Le numéro attribué au formulaire</p></item>
<item><p><code>[form_user]</code> : Expéditeur du formulaire</p></item>
<item><p><code>[form_user_display_name]</code> : Nom de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_email]</code> : Courriel de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_var_adresse]</code> : Champ de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_var_codepostal]</code> : Champ de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_var_nom]</code> : Champ de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_var_prenom]</code> : Champ de l'expéditeur du formulaire</p></item>
<item><p><code>[form_user_var_ville]</code> : Champ de l'expéditeur du formulaire</p></item>
</list>
</section>
<section id="variables_site">
<title>Variables système liées au site</title>
<list>
<item><p><code>[site_name]</code> : Titre du site</p></item>
<item><p><code>[site_theme]</code> : Nom du thème actuel</p></item>
<item><p><code>[site_url]</code> : L'adresse du site</p></item>
<item><p><code>[site_url_backoffice]</code> : L'adresse du backoffice du site</p></item>
<item><p><code>[site_lang]</code> : le code de langue utilisée par le site</p></item>
<item><p><code>[today]</code> : Date actuelle</p></item>
<item><p><code>[now]</code> : Date et heure actuelles</p></item>
</list>
</section>
<section id="variables_categories">
<title>Variables système liées aux catégories</title>
<list>
<item><p><code>[category_name]</code> : L'intitulé de la catégorie</p></item>
<item><p><code>[category_description]</code> : La description de la catégorie</p></item>
<item><p><code>[category_id]</code> : L'identifiant de la catégorie</p></item>
</list>
</section>
<section id="utilisateur">
<title>Variables système liées à l'utilisateur</title>
<list>
<item><p><code>[session_user]</code> : Utilisateur connecté</p></item>
<item><p><code>[session_user_display_name]</code> : Nom complet de l'utilisateur connecté</p></item>
<item><p><code>[session_user_email]</code> : Courriel de l'utilisateur connecté</p></item>
<item><p><code>[session_user_var_adresse]</code> : Champ utilisateur connecté : Adresse</p></item>
<item><p><code>[session_user_var_codepostal]</code> : Champ utilisateur connecté : Code postal</p></item>
<item><p><code>[session_user_var_nom]</code> : Champ utilisateur connecté : Nom</p></item>
<item><p><code>[session_user_var_prenom]</code> : Champ utilisateur connecté : Prénom</p></item>
<item><p><code>[session_user_var_ville]</code> : Champ utilisateur connecté : Ville</p></item>
</list>
</section>
<section id="variables_specifiques">
<title>Variables spécifiques</title>
<p>Le contenu de chaque champ d'un formulaire est stocké dans une variable utilisable selon le même schéma que les variables prédéfinies. Pour appeler ces contenus il faut saisir le nom de la variable (toujours entre crochets), sous la forme :
<code><var>nom_de_variable_du_formulaire</var>_var_<var>nom_de_variable_du_champ</var></code></p>
<p>Par exemple pour un formulaire de contact dont le nom de variable est <code>contact_interne</code>, on obtiendra le contenu du champ téléphone (dont le nom de variable est <code>telephone</code>) en mettant dans le modèle de message <code>[contact_interne_var_telephone]</code>).</p>
</section>
</page>