DocList : Différence entre versions

De YoWiki
Sauter à la navigation Sauter à la recherche
(Page créée avec « <h1 id="doclist">Doclist</h1> <p>La DocList indique au système tous les documents & fichiers qui peuvent être générés dans le cadre de ce fichier de paramétrage.... »)
 
 
(21 révisions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 
<h1 id="doclist">Doclist</h1>
 
<h1 id="doclist">Doclist</h1>
 +
<h2 id="intro">Introduction</h2>
 
<p>La DocList indique au système tous les documents &amp; fichiers qui peuvent être générés dans le cadre de ce fichier de paramétrage.</p>
 
<p>La DocList indique au système tous les documents &amp; fichiers qui peuvent être générés dans le cadre de ce fichier de paramétrage.</p>
−
<p>Elaboration de la DocList : </p>
+
<p>Chaque nouvelle ligne remplie dans la DocList correspond à un nouvel output généré par le système.</p>
−
<p><img src="/capture_d’écran_2019-07-15_à_16.29.17.png =x89" alt="capture_d’écran_2019-07-15_à_16.29.17.png"></p>
+
<h2 id="creation">Elaboration de la DocList</h2>
 +
<p>
 +
[[Fichier:DocList.png|1200px|sans_cadre|néant|Une feuille DocList]]
 +
</p>
 
<ul>
 
<ul>
 
<li>doc-id : c’est le nom du document pour le système, celui-ci ne sera jamais vu par l’utilisateur.
 
<li>doc-id : c’est le nom du document pour le système, celui-ci ne sera jamais vu par l’utilisateur.
Ligne 8 : Ligne 12 :
 
<li>title : c’est le titre du document, visible par l’utilisateur final.</li>
 
<li>title : c’est le titre du document, visible par l’utilisateur final.</li>
 
<li>description : c’est une description du document, qui apparaît en dessous du title. Elle doit normalement rester brève.</li>
 
<li>description : c’est une description du document, qui apparaît en dessous du title. Elle doit normalement rester brève.</li>
−
<li>visible if : il s&#39;agit de conditionner l&#39;apparition du document, le fonctionnement étant similaire au reste du système → voir <a href="http://wiki.hercule.co/Conditions">ici</a></li>
+
<li>[[Conditions|visible if]]: il s&#39;agit de conditionner l&#39;apparition du document, le fonctionnement étant similaire au reste du système → [[Conditions|Visible if]]
−
<li>type : permet de définir le type d&#39;output entre &quot;manual&quot;, &quot;smartdocx&quot;, &quot;twig&quot;, et laisser le champ vide, se reporter à la <a href="http://wiki.hercule.co/Output">page sur les types d&#39;output</a></li>
+
<p>Dans le cas de la DocList, les visible ifs sont plus “puissants” et permettent donc de ne pas délivrer un output à l’utilisateur final si les conditions ne sont pas remplies.</p>
−
<li>datastore : permet de définir le jeu de données à depuis lequel l&#39;output va s&#39;alimenter</li>
+
</li>
 +
<li>type : permet de définir le type d'output, parmi
 +
<p>- Le [[SmartDoc]] - laisser la colonne vide, car le SmartDoc est l'output par défaut. On peut aussi écrire <code>smartdoc</code></p>
 +
<p>- Le [[Twig]] - écrire <code>twig</code> dans la colonne</p>
 +
<p>- Le [[SmartDocX]] - écrire <code>smartdocx</code> dans la colonne</p>
 +
<p>- Le [[Docx-template]] - écrire <code>docx-template</code> dans la colonne</p>
 +
</li>
 +
<li>[[DataStore]] : permet de définir le jeu de données à depuis lequel l&#39;output va s&#39;alimenter : <code>mainstore</code> dans la majorité des cas.</li>
 
</ul>
 
</ul>
−
<p>Dans le cas de la DocList, les visible ifs sont plus “puissants” et permettent donc de ne pas délivrer un output à l’utilisateur final si les conditions ne sont pas remplies.</p>
+
<h2 id="docspe">Documents spéciaux au sein de la DocList</h2>
 +
<h3 id="result">Paramétrage des espaces de fin de formulaire</h3>
 +
<h4 id="generalites">Généralités</h4>
 +
<p>La DocList permet aussi de paramétrer les espaces de fin des formulaires.</p>
 +
<p>En effet, chaque formulaire peut donner lieu à une page de fin spécifique, qu'il convient de paramétrer.</p>
 +
<p>On entend par "Espace de fin" la page Web sur laquelle l'utilisateur est automatiquement emmené lorsqu'il a fini de compléter un formulaire et qu'il soumet celui-ci. Sur le concept de soumission, veuillez vous reporter à la page suivante : [[YOProcess#Pr.C3.A9cision_:_le_concept_de_.22Soumission.22_d.27un_formulaire|Prise en main de YOProcess]].</p>
 +
<h4 id="paramétrage">Paramétrage</h4>
 +
<h5 id="param">Paramétrage</h4>
 +
[[Fichier:Paramétrage twig RESULT .png|1250px|thumb|néant|La mise au point des espaces de fin avec la syntaxe RESULT_]]
 +
<p>L'ID d'un espace de fin de formulaire doit forcément commencer par <code>RESULT_</code></p>
 +
<p>L'indication <code>RESULT_</code> doit être suivie de l'ID du formulaire auquel est relié cet espace de fin</p>
 +
<p>Le type d'un espace de fin est forcément <code>Twig</code>.</p>
 +
<p>Vous pouvez apprendre à paramétrer des fichiers [[Twig]] sur la [[Twig|page dédiée]].</p>
 +
<h5 id="match">Correspondance</h5>
 +
[[Fichier:Correspondance result-id du form.png|850px|thumb|néant|Illustration de la correspondance entre l'id du RESULT_ et l'id du formulaire]]

Version actuelle datée du 27 août 2020 à 08:06

Doclist

Introduction

La DocList indique au système tous les documents & fichiers qui peuvent être générés dans le cadre de ce fichier de paramétrage.

Chaque nouvelle ligne remplie dans la DocList correspond à un nouvel output généré par le système.

Elaboration de la DocList

Une feuille DocList

  • doc-id : c’est le nom du document pour le système, celui-ci ne sera jamais vu par l’utilisateur. La feuille qui matérialise le doc doit donc porter le même nom.
  • title : c’est le titre du document, visible par l’utilisateur final.
  • description : c’est une description du document, qui apparaît en dessous du title. Elle doit normalement rester brève.
  • visible if: il s'agit de conditionner l'apparition du document, le fonctionnement étant similaire au reste du système → Visible if

    Dans le cas de la DocList, les visible ifs sont plus “puissants” et permettent donc de ne pas délivrer un output à l’utilisateur final si les conditions ne sont pas remplies.

  • type : permet de définir le type d'output, parmi

    - Le SmartDoc - laisser la colonne vide, car le SmartDoc est l'output par défaut. On peut aussi écrire smartdoc

    - Le Twig - écrire twig dans la colonne

    - Le SmartDocX - écrire smartdocx dans la colonne

    - Le Docx-template - écrire docx-template dans la colonne

  • DataStore : permet de définir le jeu de données à depuis lequel l'output va s'alimenter : mainstore dans la majorité des cas.

Documents spéciaux au sein de la DocList

Paramétrage des espaces de fin de formulaire

Généralités

La DocList permet aussi de paramétrer les espaces de fin des formulaires.

En effet, chaque formulaire peut donner lieu à une page de fin spécifique, qu'il convient de paramétrer.

On entend par "Espace de fin" la page Web sur laquelle l'utilisateur est automatiquement emmené lorsqu'il a fini de compléter un formulaire et qu'il soumet celui-ci. Sur le concept de soumission, veuillez vous reporter à la page suivante : Prise en main de YOProcess.

Paramétrage

Paramétrage
La mise au point des espaces de fin avec la syntaxe RESULT_

L'ID d'un espace de fin de formulaire doit forcément commencer par RESULT_

L'indication RESULT_ doit être suivie de l'ID du formulaire auquel est relié cet espace de fin

Le type d'un espace de fin est forcément Twig.

Vous pouvez apprendre à paramétrer des fichiers Twig sur la page dédiée.

Correspondance
Illustration de la correspondance entre l'id du RESULT_ et l'id du formulaire
Récupérée de « https://wiki.hercule.co/index.php?title=DocList&oldid=808 »