https://wiki.hercule.co/api.php?action=feedcontributions&feedformat=atom&user=L%C3%A9oYoWiki - Contributions de l’utilisateur [fr]2026-05-07T13:40:13ZContributions de l’utilisateurMediaWiki 1.33.0https://wiki.hercule.co/index.php?title=SmartExpressions&diff=1194SmartExpressions2025-01-30T09:24:11Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second". <br/><br />
+ Unité spéciale pour la France et ses territoires : "jour_ouvrable", "jour_ouvré", "jour_franc", "mois_franc" (tenant compte des jours fériés Français) <br/><br />
+ Mais aussi l'unité particulière `month_quant` qui correspond à une règle administrative courante dîtes de "mois de même quantième". On parle par exemple d'un délais de 3 mois au même quantième. Cela signifie que l'on avance de 3 mois et que le jour de destination doit être le même que celui de départ (Ex: 15 Mars + 3 mois = 15 juin). Néanmoins, cette unité prend aussi en compte le fait que si la date de destination n'existe pas (ex: 31 Aout + 1 mois), alors on renvoie le dernier jour du mois de destination (= ici le 30 Septembre).<br />
<br />
</li><br />
<li> 4 - '''''(facultatif)''''' La zone géographique qui doit être utilisée pour calculer les jours fériés (utile uniquement pour le calcul des jours spéciaux tel que ''jour_ouvré'' etc.). À choisir parmi : ''Métropole, Alsace-Moselle, Guadeloupe, Guyane, Martinique, Mayotte, Nouvelle-Calédonie, La Réunion,<br />
Polynésie Française, Saint-Barthélémy, Saint-Martin, Wallis-et-Futuna, Saint-Pierre-et-Miquelon''.<br />
</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
<br />
<div><br />
Avec un calcul de jour ouvré (ajout de 4 jours ouvrés à la date de signature en tenant compte des jours fériés de l'Alsace-Moselle) :<br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 4, "jour_ouvré", "Alsace-Moselle")</code> => renvoie <code>18/05/2017</code> (car il saute le week-end) </p><br />
</div><br />
<br />
</div><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Pour aller plus loin :</b></p><br />
<div>Dans les exemples précédents, la seule variable était ''DATE_SIGNATURE'' (avec pour valeur ''12/05/2020''). Cependant, comme dans toute SmartExpression, les valeurs statiques (nombre, chaîne…) peuvent toujours être substituées par une valeur variable. Pour l'exemple, on aurait très bien pu utiliser deux autres variables et les utiliser dans le <code>date_sum(…)</code>. Par exemple, avec <code>AJOUT_NUM</code> qui vaudrait 3 (issue d'un champ numérique), et la variable <code>AJOUT_UNITÉ</code> qui vaudrait <code>day</code> (issue d'un champ de choix par exemple), : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, AJOUT_NUM, AJOUT_UNITÉ)</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date de départ (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Date de fin (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 3 - L'unité dans laquelle renvoyer la différence entre les deux dates. L'unité est fournie sous la forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second". <br/><br />
+ Unité spéciale pour la France et ses territoires : "jour_ouvrable", "jour_ouvré" <br/><br />
</li><br />
<li> 4 - '''''(facultatif)''''' La zone géographique qui doit être utilisée pour calculer les jours fériés (utile uniquement pour le calcul des jours spéciaux tel que ''jour_ouvré'' etc.). À choisir parmi : ''Métropole (par défaut), Alsace-Moselle, Guadeloupe, Guyane, Martinique, Mayotte, Nouvelle-Calédonie, La Réunion,<br />
Polynésie Française, Saint-Barthélémy, Saint-Martin, Wallis-et-Futuna, Saint-Pierre-et-Miquelon''.<br />
</li><br />
</ul><br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
Notez que la date de fin n'est généralement pas inclue dans la comptage de la différence. <br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates) <br/><br />
▷ <code>date_diff("01-05-2020","31-05-2020", "day")</code> => renvoie <code>30</code> (le nombre total de jour entre le 01 et le 31 Mai, le 31 Mai n'étant pas inclu). <br/><br />
▷ <code>date_diff("01-05-2020","31-05-2020", "jour_ouvré")</code> => renvoie <code>18</code> (le nombre de jours ouvrés entre le 01 et le 31 Mai 2020). <br/><br />
▷ <code>date_diff("01-05-2020","31-05-2020", "jour_ouvré", "Martinique")</code> => renvoie <code>17</code> (le nombre de jours ouvrés entre le 01 et le 31 Mai 2020 en Martinique, car contrairement à la Métropole, le 22 Mai est aussi férié). <br/><br />
<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== Connaître le jour de la semaine =====<br />
<br />
# Fonction : <code>date_weekday</code> , renvoie la valeur numérique du jour de la semaine (1 pour lundi, 7 pour dimanche).<br />
<br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_weekday(DATE_SIGNATURE)</code> => Renvoie 1 pour lundi, 2 pour mardi…, 6 pour samedi, 7 pour dimanche</p><br />
<br />
===== Savoir si le jour est ouvrable, ouvré, ou férié =====<br />
<br />
# Fonction : <code>day_is</code> , renvoie un booléen (VRAI ou FAUX) si la date est du type demandé.<br />
<br />
# Paramètres attendus : <code>2</code> ou <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - La date questionnée (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Le type de jour demandée parmi : <code>weekend</code>, <code>ouvré</code>, <code>ouvrable</code>, <code>férié</code></li><br />
<li> 3 - '''''(facultatif)''''' La zone géographique qui doit être utilisée pour calculer les jours fériés (utile uniquement pour le calcul des jours spéciaux tel que ''jour_ouvré'' etc.). À choisir parmi : ''Métropole (par défaut), Alsace-Moselle, Guadeloupe, Guyane, Martinique, Mayotte, Nouvelle-Calédonie, La Réunion,<br />
Polynésie Française, Saint-Barthélémy, Saint-Martin, Wallis-et-Futuna, Saint-Pierre-et-Miquelon''.<br />
</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p> ▷ <code>day_is("25-12-2021", "férié")</code> => renvoie <code>TRUE</code> car le jour de Noël est férié<br/><br />
▷ <code>day_is("26-12-2021", "férié")</code> => renvoie <code>FALSE</code><br/><br />
▷ <code>day_is("26-12-2021", "weekend")</code> => renvoie <code>TRUE</code> car ce jour est un dimanche.<br/><br />
▷ <code>day_is("23-12-2021", "ouvré")</code> => renvoie <code>TRUE</code> car ce jour est un jeudi, non-férié.<br/><br />
▷ <code>day_is("22-05-2021", "ouvré")</code> => renvoie <code>TRUE</code> car ce jour est un vendredi, non-férié (en Métropole du moins).<br/><br />
▷ <code>day_is("22-05-2021", "ouvré", "Martinique")</code> => renvoie <code>FALSE</code> car ce jour est férié en Martinique contrairement à la Métropole.<br/><br />
</p><br />
</div><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
<br />
===== Arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<p>La méthode utilisée est celle de l'arrondi [https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique arithmétique].</p><br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
<br />
<br />
===== Arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
<br />
<br />
===== Arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
<br />
<br />
===== Tronquer le nombre de décimale (sans arrondir) =====<br />
<br />
# Fonction : <code>truncate</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Deux nombres. Le premier est la valeur à tronquer (ex: 3.1415) et le second est le nombre de décimale à garder après la virgule (Ex: 2).<br />
<br />
''La fonction va tronquer les décimales au nombre de décimales indiqué dans le second paramètre.''<br />
<br />
<p>Par exemple :<br/><br />
Avec PRIX_ACHAT qui est issu d'un calcul et vaut 1.336666, alors <code>truncate(PRIX_ACHAT, 2)</code> vaudra <code>1.33</code>.<br />
</p><br />
<br />
<br />
===== Valeur absolue =====<br />
<br />
# Fonction : <code>abs</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : le nombre (positif ou négatif) à convertir en valeur absolue.<br />
<br />
''La fonction va permettre de ramener les nombres négatifs à leur valeur positive (nombre absolu).''<br />
<br />
<p>Par exemple :<br/><br />
Avec une variable VARIATION qui est issu d'un calcul et qui vaut -6.34, alors <code>abs(VARIATION)</code> vaudra <code>6.34</code>.<br />
</p><br />
<br />
<br />
===== Minimum ou Maximum =====<br />
<br />
# Fonction : <code>max</code> ou <code>min</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : les deux nombres à comparer.<br />
<br />
''La fonction va permettre de renvoyer la valeur maximale (ou minimale) entre le paramètre 1 et 2.''<br />
<br />
<p>Par exemple :<br/><br />
: - <code>max(-6, 55)</code> vaut <code>55</code>.<br />
: - <code>max(100, 8)</code> vaut <code>100</code>.<br />
: - <code>min(100, 8)</code> vaut <code>8</code>.<br />
: - <code>min(-99, 300)</code> vaut <code>-99</code>.<br />
</p><br />
<br />
<br />
<br />
===== Formater un nombre en chaîne de caractère =====<br />
<br />
# Fonction : <code>numFormat</code> <br />
# Nombre de paramètres : <code>4</code> mais seulement le 1er est obligatoire.<br />
# Paramètres : <br />
## - (numérique) le nombre à formater (obligatoire)<br />
## - (numérique) le nombre de décimales à forcer (par défaut, le nombre de décimale d'origine)<br />
## - (string) le caractère pour le séparateur des milliers (ex: <code>","</code> ou <code>" "</code>, ou <code>""</code> etc.). Par défaut: <code>" "</code>.<br />
## - (string) le caractère pour le séparateur de l'entier/décimale (ex: <code>"."</code> ou <code>","</code> etc.). Par défaut: <code>","</code><br />
<br />
<br />
''La fonction va permettre de formater un nombre, par exemple pour faire apparaitre des séparateurs de milliers, ou personnaliser les décimales etc.''<br/><br />
''Le fonctionnement est très similaire au traitement <code>:num-format</code> des SmartDocs.''<br />
<br />
<br />
Par exemple :<br />
: - <code>numFormat(1003.1415, 2)</code> vaut <code>1 003,14</code>.<br />
: - <code>numFormat(8133003.1415, 0)</code> vaut <code>8 133 003</code>.<br />
: - <code>numFormat(3500)</code> vaut <code>3 500</code>.<br />
: - <code>numFormat(3500.999)</code> vaut <code>3 500,999</code>.<br />
: - <code>numFormat(3000.50, 4, ',', '.')</code> vaut <code>3,500.5000</code>.<br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
<br />
===== Compter le nombre de caractères d'une chaîne =====<br />
<br />
# Fonction : <code>stringLength</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]).<br />
<br />
<p>''Renvoie le nombre de caractère de la chaîne.''<br/><br />
:: Exemple : <code>stringLength('Hercule !')</code> renvoie <code>9</code> ''(entier numérique)''. </p><br />
:: <p>Les espaces ou les sauts de lignes comptent aussi pour 1 caractère, même s'ils apparaissent en début ou en fin de la chaîne.</p><br />
:: <p>Spécial : si la valeur passée en paramètre est une valeur numérique, la fonction renverra le nombre de "digit" de ce nomnre. <br/>Ex : Avec <code>CODE_POSTAL</code> qui vaut <code>34700</code> (entier numérique), alors <code>stringLength(CODE_POSTAL)</code> renvoie <code>5</code>. </p><br />
:: <p>Si par contre la valeur passée en paramètre est d'un autre type (exemple : une liste, un booléen), ces types n'étant pas pris en charge, la fonction renverra systématiquement <code>0</code>.</p><br />
<br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
<br />
===== Un élément en contient-il un autre ? =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <br />
::::1er paramètre : une Chaine A ([[DataStore|string]]) ou une Liste ([[DataStore|list]])<br />
::::Paramètre 2 : une chaîne B ([[DataStore|string]])<br />
<br />
<p>Si le 1er paramètre est une chaîne : renvoie VRAI si la chaîne A contient la chaîne B.</p><br />
<p>Si le 1er paramètre est une liste : renvoie VRAI si la liste contient la valeur B correspondante à la chaîne B.</p><br />
<p>Si le 1er paramètre est <code>null</code> ou d'un autre format non-attendu (booléen, nombre…) : la fonction renverra <code>null</code> par défaut.</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Exemple :</b></p><br />
<p>Soit une chaîne NUM_FACTURE correspondant à un numéro de facture tel que : '2020F01'. <br/><br />
Et soit une Liste HOBBIES correspondants à 3 choix : <code>["sport", "cinema", "music"]</code> (saisis par exemple via un champ de choix multiple). <br />
<p> ▷ <code>contains(NUM_FACTURE,"F")</code> => renvoie <code>VRAI</code> car la chaine "2020F01" contient la chaine "F" <br/> <br />
▷ <code>contains(NUM_FACTURE,"2020F")</code> => renvoie <code>VRAI</code> car la chaine "2020F01" contient aussi la chaine "2020F" <br/> <br />
▷ <code>contains(NUM_FACTURE,"20 Euros")</code> => renvoie <code>FALSE</code> car la chaine "2020F01" ne contient pas "20 Euros" <br/> <br />
▷ <code>contains(HOBBIES,"cinema")</code> => renvoie <code>VRAI</code> et c'est d'ailleurs le 2ème élément <br/> <br />
▷ <code>contains(HOBBIES,"cine")</code> => renvoie <code>FALSE</code> car aucun élément est exactement nommé "cine" parmi ceux de la liste <br/><br />
</p><br />
</div><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
===== Connaître la position d'une sous-chaîne =====<br />
<br />
# Fonction : <code>stringPos</code><br />
# Nombre de paramètres : 2 obligatoires, et un dernier facultatif.</code><br />
# Paramètres attendus : <br />
## La chaîne de caractères dans laquelle rechercher. (Ex: <code>"Maison d'été"</code>)<br />
## La chaîne de caractères (ou simplement le caractère) à rechercher (Ex: la lettre <code>"n"</code>)<br />
## (Optionnel) un nombre entier correspondant à la position de début de recherche. S'il est omis, zéro sera utilisé. Une position négative compte à partir de la fin de la chaîne de caractères n°1.<br />
<br />
Notez que le premier caractère est comptabilisé comme à la position n°0.<br />
<br />
Ex: <code>stringPos("Maison d'été", "n")</code> va retourner 5 car la lettre <code>n</code> se trouve à la 5ème position de la chaîne fournie (la lettre <code>M</code> étant comptée comme la position n°0)<br />
<br />
Ex: <code>stringPos("Maison d'été", "été")</code> va retourner 9 car le terme <code>été</code> se trouve à la 9ème position de la chaîne fournie.<br />
<br />
Ex: <code>stringPos("Blablabla", "a", 3)</code> va retourner 5 car, si on omet les 3 premiers caractères, la prochaine lettre <code>a</code> se trouve à la 5ème position de la chaîne fournie.<br />
<br />
<br />
<br />
===== Tronquer la chaîne avec tout ce qui est "avant" une sous-chaîne =====<br />
<br />
# Fonction : <code>stringBefore</code><br />
# Nombre de paramètres : 1 obligatoire, 1 facultatif.</code><br />
# Paramètres attendus : <br />
## La chaîne de caractères dans laquelle rechercher. <br />
## (Optionnel) La chaîne de caractères (ou simplement le caractère) à partir duquel il faut tronquer. Si rien n'est précisé, le caractère <code>,</code> sera utilisé.<br />
<br />
Ex: <code>stringBefore("Maison d'été", " ")</code> va retourner <code>Maison</code> car on lui demande de ne retourner que ce qui est avant l'espace.<br />
<br />
Ex: <code>stringBefore("Damien, Jean, Paul")</code> va retourner <code>Damien</code> car on lui demande de ne retourner que ce qui est avant la virgule (la virgule étant la valeur par défaut du second paramètre quand il n'est pas précisé).<br />
<br />
<br />
===== Tronquer la chaîne avec tout ce qui est "après" une sous-chaîne =====<br />
<br />
# Fonction : <code>stringAfter</code><br />
# Nombre de paramètres : 1 obligatoire, 1 facultatif.</code><br />
# Paramètres attendus : <br />
## La chaîne de caractères dans laquelle rechercher. <br />
## (Optionnel) La chaîne de caractères (ou simplement le caractère) jusqu'auquel il faut tronquer. Si rien n'est précisé, le caractère <code>,</code> sera utilisé.<br />
<br />
Ex: <code>stringAfter("Maison d'été", " ")</code> va retourner <code>d'été</code> car on lui demande de ne retourner que ce qui est après l'espace.<br />
<br />
Ex: <code>stringAfter("Damien, Jean, Paul")</code> va retourner <code> Jean, Paul</code> car on lui demande de ne retourner que ce qui est après la virgule (la virgule étant la valeur par défaut du second paramètre quand il n'est pas précisé).<br />
<br />
<br />
===== Rechercher et remplacer dans une chaîne =====<br />
<br />
# Fonction : <code>stringReplace</code><br />
# Nombre de paramètres : 2 obligatoires, 1 facultatif.</code><br />
# Paramètres attendus : <br />
## La chaîne de caractères dans laquelle rechercher et remplacer ;<br />
## La chaîne de caractères de remplacement (celle qui sera "insérée") ;<br />
## (Optionnel) La chaîne de caractères qui sera recherchée et remplacée. Par défaut, ce sont des sauts de ligne (<code>\n</code>) qui seront recherchés et remplacés.<br />
<br />
Ex: <code>stringReplace("Damien", "F", "D")</code> va retourner <code>Famien</code> car on lui demande de remplacer <code>D</code> par <code>D</code> dans la chaîne <code>Damien</code>.<br />
<br />
Ex: par exemple une variable ADDRESS qui contient une adresse postale sur plusieurs lignes, <code>stringReplace(ADDRESS, ", ")</code> va permettre de la renvoyer sur une seule et même ligne (séparée par des virgules). Le troisième paramètre n'est pas précisé car par défaut, ce sont des sauts de ligne qui sont recherchés et remplacés. <br />
<br />
A l'inverse, pour remplacer des virgules par des sauts de ligne, il faudra écrire l'expression de cette façon : <code>stringReplace(ADDRESS, "\n", ",")</code>.<br />
<br />
==== Fonctions sur des listes ====<br />
<br />
===== Obtenir la valeur d'un élément d'une liste à partir d'une clé dynamique =====<br />
<br />
# Fonction : <code>get_value</code><br />
# Nombre de paramètres : <code>2 ou 3</code><br />
# Paramètres attendus : <br />
## - Une variable de type [[DataStore|List]] ;<br />
## - La clé à cibler ;<br />
## - Dans le cas d'une liste "structurée" (issue d'un [[Repeaters|Repeater]] par exemple), on peut préciser le nom de la sous-variable à renvoyer.<br />
<br />
'''Cas pratique'''<br />
<p>Cas d'une liste EMPLOYES, utilisée dans un Repeater, dont chaque élément défini 3 sous-variables: <code>EMPLOYES.NOM</code>, <code>EMPLOYES.DATE_ENTREE</code>, <code>EMPLOYES.SALAIRE</code>. <br/><br />
Ceci étant, l'utilisateur a renseigner dans un formulaire 2 fiches correspondante à EMPLOYES. Elles ont respectivement les clés '_abc123' et '_xyz987' : <br />
</p><br />
<pre><br />
[<br />
'_abc123' => [ 'NOM': 'Jean', 'DATE_ENTREE': '13-08-2020', 'SALAIRE': 32000.00 ,<br />
'_xyz987' => [ 'NOM': 'Sylvie', 'DATE_ENTREE': '11-12-2019', 'SALAIRE': 39500.00<br />
]<br />
</pre><br />
<br />
'''Usage'''<br />
<p><br />
- <code>get_value(EMPLOYES, '_abc123', 'NOM')</code> => va renvoyer "Jean" <br/><br />
- <code>get_value(EMPLOYES, '_xyz987', 'SALAIRE')</code> => va renvoyer <code>39500.0</code><br />
</p><br />
<br />
<p><br />
Mais là où cette fonction prend tout son intérêt, c'est quand le second paramètre est dynamique, c'est à dire qu'il est fourni au travers d'une variable.<br/><br />
Prenons par exemple, une variable "MEILLEUR_EMPLOYE", qui serait utilisée dans un formulaire avec un champ "choice-list", et qui prendra pour valeur la clé correspondante au meilleur employé de l'entreprise (= c'est à dire '_abc123' ou '_xyz987' dans notre exemple). <br />
<br/><br />
- <code>get_value(EMPLOYES, MEILLEUR_EMPLOYE, 'SALAIRE')</code> => va renvoyer le salaire du meilleur employé selon le choix effectué.<br/><br />
</p><br />
<br />
<br />
===== Savoir si une liste contient ou pas une certaine clé =====<br />
<br />
# Fonction : <code>has_key</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <br />
## - Une variable de type [[DataStore|List]] ;<br />
## - La clé à rechercher ;<br />
<br />
'''Usage'''<br />
<p><br />
- <code>has_key(EMPLOYES_CDI, '_abc123')</code> => va renvoyer TRUE si la liste EMPLOYES_CDI contient bien la clé '_abc123' <br />
</p><br />
<br />
<p><br />
Tout comme pour la fonction <code>get_value</code> cette fonction prend tout son intérêt quand le second paramètre est dynamique, c'est à dire qu'il est fourni au travers d'une variable.<br/><br />
Prenons par exemple, une variable "MEILLEUR_EMPLOYE", qui serait utilisée dans un formulaire avec un champ "choice-list", et qui prendra pour valeur la clé correspondante au meilleur employé de l'entreprise (= c'est à dire '_abc123' ou '_xyz987' dans notre exemple).<br/> <br />
S'il on veut savoir si cet employé fait parti de la liste de ceux qui sont en CDI, on pourrait faire : <br/><br />
- <code>has_key(EMPLOYES_CDI, MEILLEUR_EMPLOYE)</code> => va renvoyer TRUE si la clé renseignée dans <code>MEILLEUR_EMPLOYE</code> se trouve bien dans la liste <code>EMPLOYES_CDI</code>.<br />
</p><br />
<br />
<br />
<br />
===== Assigner un nouveau couple clé-valeur dans une liste =====<br />
<br />
# Fonction : <code>set_in_struct</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : <br />
## - Une variable de type [[DataStore|List]] ;<br />
## - La clé à créer ou mettre à jour (string);<br />
## - La valeur a assigner ;<br />
<br />
<br />
'''Usage'''<br />
<p><br />
- <code>set_in_struct(PRODUITS, CODE_PRODUIT, PRIX)</code> => va renvoyer la liste PRODUITS avec la nouvelle valeur assignée. <br />
</p><br />
<br />
'''Explication'''<br />
<p><br />
Dans l'exemple ci-dessous, nous avons imaginé une liste PRODUITS qui serait de la forme : <br />
<pre>[ '_abc123' => 12.50, '_xyz985' => 89.99 ]</pre><br />
- <code>CODE_PRODUIT</code> est une variable "string", par exemple "_bcd456" ; <br/><br />
- <code>PRIX</code> est une variable "numerique", par exemple <code>13.50</code> ; <br/><br />
<br/><br />
Ceci étant, l'instruction ci-dessus, va retourner une liste de la forme :<br />
<pre>[<br />
'_abc123' => 12.50,<br />
'_xyz985' => 89.99,<br />
'_bcd456' => 13.50,<br />
]</pre><br />
<br />
<br />
===== Additionner les répétitions d'une sous-variable d'une liste structurée =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <br />
## - Une variable de type [[DataStore|List]] (utilisée par exemple dans un [[Repeaters|Repeater]]) ;<br />
## - Le nom de la sous-variable qui devra être additionnée ;<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</code></p><br />
<br />
<br />
===== Obtenir une copie filtrée d'une liste à partir d'une série de clés =====<br />
<br />
# Fonction : <code>filter_by_keys</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <br />
## - Une liste avec des clés et des valeurs (ex: <code>ASSOCIES</code>);<br />
## - Une liste de clés ;<br />
::'''Exemple de paramétrage :'''<br />
::<p>Pour obtenir une copie de la liste des associés mais avec uniquement ceux qui ont été cochés comme "présents" :</p><br />
::<p><code>filter_by_keys(ASSOCIES, ASSOCIES_PRESENTS)</code></p><br />
<br />
===== Montrer et organiser les valeurs d'une liste (à rerédiger plus parfaitement) =====<br />
<br />
# Fonction : <code>join</code><br />
# Nombre de paramètres : <code>5</code><br />
# Paramètres attendus : <br />
## - Une variable de liste (paramètre obligatoire) ;<br />
## - Séparateur (facultatif) ; <br />
## - Dernier séparateur (facultatif) ; <br />
## - Préfixe (facultatif) ; <br />
## - Suffixe (facultatif)<br />
<br />
::'''Exemple de paramétrage :'''<br />
<p>Il est possible de combiner "join" avec la fonction "filter_by_keys".</p><br />
<p>Par ex : join( filter_by_keys(FILIALES_DISPLAY, CONV.TRESO_FILIALES_PARTICIPANTES) , "", "", "\t - ", " ; \n")</p><br />
<br />
==== Fonctions autres ====<br />
<br />
===== Vérifier si une variable est "vide" =====<br />
<br />
# Fonction : <code>is_empty</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une variable de n'importe quel type<br />
# Exemple : <code>is_empty(MY_VAR) == true</code><br />
<br />
<p>Pour savoir si une variable ne possède aucun valeur, il est préférable de tester cela avec la fonction <code>is_empty</code>.</p><br />
<p>La fonction renverra VRAI pour n'importe quelle variable vide : '' (chaîne vide), liste vide …</p><br />
<p>Par contre, la fonction renverra FALSE si une valeur est présente, même si cette valeur est un 0 ou le booléen "false" (c'est d'ailleurs pour cela qu'il est préférable d'utiliser <code>`is_empty(MY_VAR)`</code> au lieu de, par exemple, <code>`MY_VAR = null`</code>.</p><br />
<br />
===== Vérifier si une variable est "non vide" =====<br />
<br />
# Fonction : <code>is_set</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une variable de n'importe quel type<br />
# Exemple : <code>is_set(MY_VAR) == true</code><br />
<br />
<p>A l'inverse de la fonction <code>is_empty</code>, la fonction <code>is_set</code> permet de savoir si une variable possède une valeur.</p><br />
<p>La fonction renverra VRAI pour n'importe quelle variable non-vide : "une chaîne", un nombre tel que 12.45 ou même 0 (zéro), une liste non-vide etc.</div>Léohttps://wiki.hercule.co/index.php?title=Treatment&diff=1170Treatment2022-11-30T08:58:53Z<p>Léo : </p>
<hr />
<div>= Introduction =<br />
<br />
[[File:Exemple-traitements.png|thumb|droite|400px|Exemple d'une table de traitements avec différents types d'instruction (et des commentaires explicatifs).]]<br />
<br />
Une table de traitement est un liste d'instruction qui peuvent s'appliquer sur un Dataset, permettant de transformer les données existantes.<br />
Les traitements sont déclenchés manuellement par l'application (via un Thème par exemple).<br />
<br />
Une Configuration peut définir plusieurs table de traitements, chacune ayant un identifiant unique (une chaîne de caractère, sans espace).<br />
<br />
Les instructions de la table de traitement sont exécutés dans l'ordre de le lecture.<br />
<br />
= Types d'instructions de traitement =<br />
<br />
Il existe plusieurs "types" d'instructions de traitement :<br />
<br />
<br />
:: — <code>set</code>. Instruction la plus élémentaire, elle consiste à '''assigner une nouvelle valeur''' à une variable à partir d'une SmartExpression fournie. La SmartExpression peut faire appel à d'autres variables du Dataset, mais aussi à d'éventuelles [[Variables_dynamiques_(DynVars)|DynVars]]. Ce type d'assignation ne peut s'appliquer que sur une variable simple (de premier niveau). <br />
:::: - Voir [[Media:Treat-ex-set-1.png|exemple illustré n°1]].<br />
:::: - Voir [[Media:Treat-ex-set-2.png|exemple illustré n°2]].<br />
<br />
<br />
:: — <code>unset</code> '''Forcer à null la valeur d'une variable'''. À l'inverse de l'instruction précédente, cette instruction permet de "vider" la valeur de la variable spécifiée. Si cette instruction est appliquée sur une variable de type "liste" alors la liste sera vidée de tous ses éléments (sous-variables etc.).<br />
:::: - Voir [[Media:Treat-ex-unset.png|exemple illustré]].<br />
<br />
<br />
:: — <code>set-all</code>. '''L'assignation multiple''' consiste à assigner une valeur à une sous-variable, pour TOUS les éléments d'une liste. La valeur est calculée à partir d'une SmartExpression qui peut faire appel à d'autres variables du Dataset, ainsi qu'à d'éventuelles [[Variables_dynamiques_(DynVars)|DynVars]]. La sous-variable ciblée est indiquée sous la forme de sa définition (Ex: ''EMPLOYÉS.DATE_ENTRÉE''). <br />
:::: - Voir [[Media:Treat-ex-setall-1.png|exemple illustré n°1]].<br />
:::: - Voir [[Media:Treat-ex-setall-2.png|exemple illustré n°2]].<br />
<br />
<br />
:: — <code>add-in-list</code>. '''L'ajout ou la mise à jour d'un élément spécifique dans une liste'''. Pour une variable de liste (Ex: EMPLOYÉS), ce type d'instruction permet d'ajouter une nouvelle entrée dans la liste et de définir sa valeur et celle de toutes ses potentielles sous-variables. <br />
<br />
:::: Par défaut, si aucune clé n'est définie, un nouvel élément est rajouté dans la liste. <br />
<br />
:::: Si une SmartExpression est fournie, et que sa valeur correspond à la clé d'un élément existant de la liste, alors cet élément sera ciblé et mis-à-jour au lieu qu'un nouvel élément soit rajouté à la fin de la liste. <br />
<br />
:::: Dans le cas d'une Liste Structurée (ex: EMPLOYÉS), les lignes suivantes dans la table permettront de définir la valeur à assigner aux sous-variables. Elles seront indiquée sous une forme simplifiée, sans re-citer la variable de liste, et donc reconnaissable car débutant par un "." (ex: <code>.DATE_ENTRÉE</code> pour définir la valeur de <code>EMPLOYÉ.DATE_ENTRÉE</code>).<br />
<br />
:::: Dans le cas d'une Liste Plate (ex: LIST_COULEURS), qui n'a pas de sous-variables par nature, il faudra utiliser la syntaxe <code>._VALUE</code> pour définir la valeur à rajouter dans la liste. <br />
<br />
:::: - Voir [[Media:Treat-ex-add-1.png|exemple illustré n°1]] (ajout).<br />
:::: - Voir [[Media:Treat-ex-add-2a.png|exemple illustré n°2]] (remplacement).<br />
:::: - Voir (@TODO) (ajout liste plate).<br />
<br />
<br />
:: — <code>remove-in-list</code> '''Le retrait d'un élément dans une liste'''. Pour une variable de liste (Ex: EMPLOYÉS), ce type d'instruction permet de supprimer une entrée en fonction d'une clé fournie au travers de la SmartExpression. <br />
:::: Si la SmartExpression renvoie une liste plate de clés, alors chacune des clés citée seront retirées (si elles existent dans la liste bien sûr). Cela permet d'effectuer une suppression "multiple". <br />
:::: - Voir [[Media:Treat-ex-remove.png|exemple illustré]] (suppression).<br />
<br />
<br />
:: — <code>merge</code> '''La fusion d'une liste sur une autre liste'''. La variable ciblée, de type "liste", se verra fusionnée à la liste renvoyée par la SmartExpression. Les valeurs indiquées dans cette dernière viendront donc remplacer les valeurs existantes dans la liste ciblée. De plus, si une des deux listes contient des éléments que l'autre liste ne connait pas (identifiés par leurs clés), alors ils seront rajoutés au résultat. <br />
:::: Dans le cas de listes structurées, il est bien entendu nécéssaire que les deux listes soient similaires au niveau des définitions de leurs sous-variables. En effet, si la liste 2 définie des sous-variables qui n'existent pas dans la liste 1, après la fusion, la liste 1 va se retrouver avec des variables qu'elle ne connait pas, et cela posera un problème d'intégrité résultant en une erreur (fusion nulle). <br />
::: - Voir exemple illustré (@TODO).<br />
<br />
<br />
:: — <code>merge-through-key</code> '''La fusion d'une liste 1 sur une liste 2, au travers d'une clé spécifiée dans la liste 2'''. Très similaire à l'instruction de fusion précédente, ce type de traitement permet de spécifier la clé de fusion de chaque élément. <br />
:::: La clé de fusion est indiquée avec la syntaxe <code>through key SUBVAR</code>, où <code>SUBVAR</code> est une sous-variable de la liste 2, ayant pour valeur une clé de la liste 1. Ce type de fusion est particulièrement utile dans le cas d'une mise à jour ciblée des éléments d'une liste.<br />
:::: - Voir [[Media:Treat-ex-merge-through-key.png|exemple illustré]] (exemple avec cumul de traitement). Dans l'exemple illustré, prenez note du retour chariot (obligatoire) entre "EMPLOYÉS" et "through".</div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=1167SmartDoc2022-10-28T09:13:14Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
=== Métadonnées ===<br />
<br />
<p> C'est un simple espace de commentaire </p><br />
<br />
=== DataStore ===<br />
<br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<br />
=== Options ===<br />
<br />
La colonne "Options" permet de définir des options relatives au document courant.<br />
Cette cellule attend un contenu au format YAML.<br />
<br />
==== L'option "title-num-display" ====<br />
<br />
L'option "title-num-display" permet de définir le format d’affichage pour la numérotation de chaque titre du document. <br />
<br />
Si cette option vaut <code>none</code> ou <code>disabled</code> les titres et les références affichées dans ce document seront "désactivées" et ne s'afficheront donc pas.<br />
<br />
Au contraire, pour personnaliser le format de la numérotation, cette option attend une liste clés-valeurs (texte indenté, YAML), où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, trois attributs peuvent être saisis : <code>style</code>, <code>format</code>, et <code>format-ref</code> (voir exemple imagée ci-dessous).<br />
<br />
Les valeurs possible pour l'attribut <code>style</code> sont :<br />
:: - "decimal" : numérotation décimale classique en chiffre arabe (1, 2 , 3 …) ;<br />
:: - "upper-roman" : nombre romain majuscule (I, II, III, IV etc.) ;<br />
:: - "lower-roman" : nombre romain minuscule (i, ii, iii, iv etc.) ;<br />
:: - "upper-alpha" : numérotation alphabétique majuscule (A, B, C, D, E) ;<br />
:: - "lower-roman" : numérotation alphabétique minuscule (a, b, c, d...) ;<br />
:: - "none" : aucune numérotation pour ce niveau de titre ;<br />
<br />
L'attribut <code>format</code> attend une chaîne de caractère qui permet de représenter le contexte (préfixe, suffixe…) de la numérotation à afficher avant chaque Titre.<br />
Cette chaîne doit contenir au moins une fois un $1, $2, $3 … $6, qui seront remplacés par la numérotation pur le niveau concerné.<br />
L'attribut <code>format-ref</code> fonctionne de la même façon que l'attribut précédent mais il permet de représenter la numérotation à afficher dans chaque référence intégrée au sein du document (voir [[Smartdoc/titre-et-references|SmartDocument, faire une référence à un titre]]).<br />
<br />
Ces attributs doivent contenir au moins une fois un code numéroté tel que <code>$1</code>, <code>$2</code>, <code>$3</code> … <code>$6</code>, qui permettra d'être remplacé par la numérotation du niveau concerné.<br />
<br />
'''Exemple''' : le format “<code>$1)</code>“ s'affichera “''A)''”, "''B)''", "''C)''" etc. (s'il est combiné au style <code>"upper-alpha"</code>), ou "i)", "ii)", "iii)" (style <code>"lower-roman"</code>). <br />
<br />
'''Autre exemple''' : “<code>Article $1.$2</code>“ s'affichera “Article 1.A”, "Article 1.B", "Article 2.A" … (combiné avec un niveau 1 au style <code>décimal</code> et un niveau 2 en <code>upper-roman</code>). <br />
<br />
'''Exemple complet :'''<br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
D'après la configuration de l'image ci-dessus, les titres :<br />
* de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”<br />
* de niveau 2 seront de la forme : “2 Lorem ipsum ”<br />
* de niveau 3 seront de la forme : “2-5 Lorem ipsum ”<br />
* de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”<br />
* de niveau 5 seront de la forme : “a. Lorem ipsum ”<br />
* de niveau 6 seront de la forme : “ iv ) Lorem ipsum<br />
<br />
=== List-Labels ===<br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
== Contenu, options, styles, [[Conditions|visible ifs]], commentaires ==<br />
<br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivantes sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span,<br />
* br<br />
<br />
</p> </br><br />
<h4 id="bases">Avertissement sur l'utilisation des balises HTML </h4><br />
<p>Veuillez prendre en compte qu'une fois que le système détecte qu'un [[Élément_de_contenu|éléments de contenu]] utilise directement une ou plusieurs balises HTML, l'ensemble de l'élément de contenu est converti au format HTML.</p><br />
<p>En conséquence, l'élément de contenu concerné ne peut <b>plus prendre en compte tout autre élément de mise en forme non-HTML</b>.</p> </br><br />
Par exemple, un saut de ligne inséré à l'aide de la combinaison ALT + ENTREE ne sera plus pris en compte dans cet élément de contenu. Il conviendra alors d'utiliser la balise <nowiki></br></nowiki> pour sauter une ligne.<br />
<br />
==== Contenu spécial ou dynamique ====<br />
<br />
Ils sont de la forme <code>{ @… }</code> et s'integre parmi le contenu. <br />
<br />
:: — <code>{ @line-break }</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> <br />
<br />
:: — <code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.<br />
:: Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.<br />
<br />
:: — <code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
:::: Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
:::: Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
:::: Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
<br />
:::: Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
:::: Exemple : ''Comme décrit dans la section'' <code>{@ref:droit-acheteur:uppercase}</code>.<br />
:::: Le traitement <code>:num</code> peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
:::: Exemple : ''Comme décrit dans la section ''<code>{@ref:droit-acheteur:num}</code>… => ''Comme décrit dans la section '' '''3.1.1.2'''<br />
<br />
:::: Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
:::: Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<br />
:: — <code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code><br />
<br />
:: — <code>{ @doc-meta(title) }</code> : permet d'insérer une méta-donnée du document courant. Les 3 paramètres possibles sont : <code>title</code>, <code>description</code>, ou <code>id</code>. Pratique, par exemple, pour citer le titre du document au sein du contenu, malgré peut-être la présence d'un clausier et de blocs injectés d'un autre document.<br />
<br />
==== Comment rendre dynamique le contenu d'un [[SmartDoc]] ? ====<br />
<br />
Pour rendre dynamique le contenu du SmartDoc, il est possible de lui intégrer les valeurs des variables telles qu'elles ont été collectée dans un formulaire, ou calculée via une variable dynamique etc. <br />
<br />
La syntaxe pour intégrer un contenu dynamique est reconnaissable car il est systématiquement placé entre accolades : <code>{ … }</code>.<br />
<br />
Une variable peut être intégrée de façon brute (Exemple : ''"Je m'appelle { PRENOM }."'').<br />
L'affichage brut pouvant parfois être trop limitatif, une syntaxe de "traitements SmartDoc" est disponible. Par exemple, le traitement <code>:uppercase</code> appliqué sur une variable la fera afficher en majuscule. Exemple :: ''"Je m'appelle <code>{ PRENOM:uppercase }</code>."'').<br />
<br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<br />
==== Les traitements dans le SmartDoc ==== <br />
<br />
<p>Les traitements peuvent être définies comme une modification appliquée sur un contenu. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong>L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<br />
==== Traitements disponibles et syntaxe spécifique ==== <br />
<br />
<p><code>:uppercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en majuscule</p><br />
<br/><br />
<p><code>:lowercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en minuscule</p><br />
<br/><br />
<p><code>:letters</code> : ne s'applique que sur une valeur numérique, et permet de la convertir en "toutes-lettres" (ex : <code>312</code> => <code>Trois-cent-douze</code>).</p><br />
<br/><br />
<p><code>:capitalize</code> : ne s'applique que sur une chaine de caractères, et permet de passer en majuscule la première lettre de chaque mot. Ex: <code>NOM:capitalize</code><br/><br />
Option : si l'option 1 (ou "yes") est passée en paramètre de ce traitement, alors seule la première lettre du premier mot sera mise en majuscule. Ex: <code>NOM:capitalize(1)</code> , <code>NOM:capitalize(yes)</code>… </p><br />
<br/><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document. Ex : <code>{"https://api.memegen.link/images/puffin.jpg":img}</code> va permettre d'intégrer l'image présente à cette URL dans le document.<br />
<br><i><b>Nb:</b></i> dans les version v0.9-v0.11 l'intégration d'une image distante (via <code>:img</code>) n'est plus possible dans les exports .docx / .pdf si un modèle de document (voir <i>docx template</i>) est utilisé. En effet, la norme DocX ne permet pas/plus l'intégration d'image / objet si le fichier est créé par un TemplateEngine. <br />
</p><br />
<br/><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<br/><br />
<p><code>:french-datetime</code> : ne s'applique que sur une date ou une chaîne de caractère au format "Date". Ce traitement permet de transformer la date au format "30/12/1985 à 12h45".</p><br />
<br/><br />
<p><code>:french-date</code> : ne s'applique que sur une date ou une chaîne de caractère au format "YYYY-MM-DD" (format international). Ce traitement permet de transformer la date fournie dans le format Français "jj/mm/aaaa". Depuis la version v0.10, ce filtre est "facultatif" car il est appliqué par défaut sur les dates ou les chaînes au format de date. </p><br />
<br/><br />
<p><code>:num-format</code> : ne s'applique que sur une valeur numérique, et permet de la formater pour son affichage. Ce traitement peut prendre 3 paramètres '''facultatifs'''. <br/><br />
<ul><br />
<li>Le 1er permet (numérique et facultatif) permet d'indiquer le nombre de décimale souhaitées (par défaut, 2 chiffres ou 0 si la partie décimale est nulle).</li><br />
<li>Le second paramètre (chaîne, facultative) correspond au séparateur des milliers (par défaut : un espace).</li><br />
<li>Le troisième paramètre (chaîne, facultative) correspond au caractère à afficher pour le séparateur décimal (par défaut : <code>,</code>).</li><br />
</ul><br />
Quelques exemples : <ul><br />
<li> - soit une variable numérique VAR_PI qui vaut <code>3,1451</code>. L'affichage par défaut <code>{ VAR_PI }</code> affichera <code>3,14</code>. <br/> L'affichage <code>{ VAR_PI:num-format(3) }</code> affichera <code>3,145</code>. </li><br />
<li> - pour la variable PRICE (numérique) qui vaudrait <code>9 999,99</code>, l'affichage <code>{ PRICE:num-format }</code> affichera <code>9 999,99</code> (dans ce cas le `:num-format` est facultatif). <br/>Par contre, l'affichage <code>{ PRICE:num-format(1,',', '.') }</code> affichera <code>9,999.9</code> (1 chiffre après la virgule, séparateur des milliers et décimaux modifiés).</li><br />
</ul><br />
</p><br />
<br/><br />
<br />
<br />
<code>:join</code> : limité à une variable de liste plate (issue d'un [[Fields-Form|multiples-choices]] principalement) → permet d'afficher les différentes valeurs de la liste sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code>. <br />
:: Il est possible de personnaliser le séparateur, par exemple <code>LIST:join(" ou ")</code> → renvoie <code>Valeur1 ou Valeur2 ou Valeur3</code>.<br />
:: Et il est même possible de personnaliser indépendamment le séparateur du dernier élément grâce à un second paramètre. Exemple <code>LIST:join(" ou ", " ou bien même ")</code> → renvoie <code>Valeur1 ou Valeur2 ou bien même Valeur3</code>. <br />
<br />
<br />
<br/><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<br/><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<br/><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
</p><br />
<br />
<br/><br />
<p><code>:string-replace([remplaceur], [remplacé])</code> : permet de remplacer une chaîne par une autre chaîne dans le contenu d'une variable de type "string". <br />
Par exemple pour une variable VAR qui vaudrait "Damien", l'expression <code>VAR:string-replace("F", "D")</code> donnera "Famien". <br/><br />
Si le paramètre "remplacé" n'est pas fourni, ce sera par défaut un saut de ligne qui sera recherché. Par exemple pour une variable ADDRESS qui contient des sauts de ligne, l'expression <code>ADDRESS:string-replace(", ")</code> va remplacer chaque saut de ligne de l'adresse par <code>, </code> ce qui permet de passer un texte multi-lignes dans un format une-ligne. <br/><br />
A savoir : un saut de ligne se note <code>"\n"</code>, il est donc aussi possible de remplacer, par exemple, des tirets <code>-</code> par des sauts de ligne avec l'expression <code>ADDRESS:string-replace("\n", "-")</code>.<br />
</p><br />
<br />
<br/><br />
<br />
<p><code>:default("texte par défaut")</code> permet de définir une valeur "par défaut" à afficher dans le SmartDoc si la variable sur laquelle le filtre est appliqué est vide.</p><br />
<br />
<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<br />
=== Styles ===<br />
<br />
La colonne Styles est facultative, et permet de personnaliser les styles de la ligne de contenu concernée. <br />
<br />
Les styles sont fournies dans un format inspiré de la norme [https://www.w3schools.com/css CSS] (mais fortement simplifiée).<br />
Ce format permet de définir plusieurs instructions stylistiques, chacune se terminant par un point-virgule (<code>;</code>) et un saut de ligne. Exemple d'une cellule dont le texte devra être en taille 18px et dans la couleur rouge (''#FF0000'' en couleur hexadécimale) : <br />
font-size:18px; <br />
color:#FF0000;<br />
<br />
Chaque instruction est donc formée : d'un attribut de style (voir la liste ci-dessous), puis d'un séparateur (caractère <code>:</code>), puis de la valeur du style souhaité, et se termine par un point-virgule (<code>;</code>) et un saut de ligne. <br />
Il est autorisé de placer un espace après le séparateur "<code>:</code>" mais attention à ce que ce espace ne soit pas "particulier" (espace insécable etc.) car cela mettrait en danger l'interprétation du style et il se peut qu'il ne soit pas du tout pris en compte.<br />
<br />
Les instructions de styles autorisées sont : <br />
<br />
:: '''Définir une police de caractère spécifique :'''<br />
:::: L'attribut “<code>font-family</code>” permet de spécifier la police à utiliser. <br />
:::: Plusieurs noms de police peuvent être proposées (dans l'ordre de priorité). Si le lecteur (navigateur, logiciel de traitement de texte…) utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...<br />
:::: Exemple : <code>font-family:Times New Roman, Times;</code><br />
:::: Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité. Le cas échéant, on utilisera "Times".<br />
<br />
:: '''Définir la taille du texte'''<br />
:::: <code>font-size:14px;</code><br />
:::: Dans cet exemple, la taille du texte sera forcée à 14px. <br />
<br />
:: '''Italique :''' <br />
:::: <code>font-style:italic;</code><br />
<br />
:: '''Gras :'''<br />
:::: <code>font-weight:bold</code><br />
<br />
:: '''Souligner le texte :'''<br />
:::: <code>text-decoration:underline;</code></p><br />
<br />
:: '''Alignement :'''<br />
:::: <code>text-align:right;</code> (aligner à droite)<br />
:::: <code>text-align:left;</code> (aligner à gauche)<br />
:::: <code>text-align:center</code> (centrer sur la page)<br />
:::: <code>text-align:justify</p></code> (justifier)<br />
<br />
NOTE : ''la suite est à finaliser et mettre au propre''<br />
<br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
<br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<br />
=== Visible if ===<br />
<br />
Ici, les [[Conditions|visible ifs]] permettront de conditionner l’apparition des contenus dans le Document.<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]].<br />
<br />
'''Particularité :''' les [[Conditions|visible ifs]] des SmartDocs peuvent utiliser la variable spéciale <code>_CURRENT_DOC_ID</code> (type ''string'') qui contient l'identifiant du document courant.<br />
<br />
=== Utiliser les [[Boucles]] ===<br />
Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]].<br />
<br />
=== Commentaire ===<br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=1166SmartDoc2022-10-28T08:53:47Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
=== Métadonnées ===<br />
<br />
<p> C'est un simple espace de commentaire </p><br />
<br />
=== DataStore ===<br />
<br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<br />
=== Options ===<br />
<br />
La colonne "Options" permet de définir des options relatives au document courant.<br />
Cette cellule attend un contenu au format YAML.<br />
<br />
==== L'option "title-num-display" ====<br />
<br />
L'option "title-num-display" permet de définir le format d’affichage pour la numérotation de chaque titre du document. <br />
<br />
Si cette option vaut <code>none</code> ou <code>disabled</code> les titres et les références affichées dans ce document seront "désactivées" et ne s'afficheront donc pas.<br />
<br />
Au contraire, pour personnaliser le format de la numérotation, cette option attend une liste clés-valeurs (texte indenté, YAML), où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, trois attributs peuvent être saisis : <code>style</code>, <code>format</code>, et <code>format-ref</code> (voir exemple imagée ci-dessous).<br />
<br />
Les valeurs possible pour l'attribut <code>style</code> sont :<br />
:: - "decimal" : numérotation décimale classique en chiffre arabe (1, 2 , 3 …) ;<br />
:: - "upper-roman" : nombre romain majuscule (I, II, III, IV etc.) ;<br />
:: - "lower-roman" : nombre romain minuscule (i, ii, iii, iv etc.) ;<br />
:: - "upper-alpha" : numérotation alphabétique majuscule (A, B, C, D, E) ;<br />
:: - "lower-roman" : numérotation alphabétique minuscule (a, b, c, d...) ;<br />
:: - "none" : aucune numérotation pour ce niveau de titre ;<br />
<br />
L'attribut <code>format</code> attend une chaîne de caractère qui permet de représenter le contexte (préfixe, suffixe…) de la numérotation à afficher avant chaque Titre.<br />
Cette chaîne doit contenir au moins une fois un $1, $2, $3 … $6, qui seront remplacés par la numérotation pur le niveau concerné.<br />
L'attribut <code>format-ref</code> fonctionne de la même façon que l'attribut précédent mais il permet de représenter la numérotation à afficher dans chaque référence intégrée au sein du document (voir [[Smartdoc/titre-et-references|SmartDocument, faire une référence à un titre]]).<br />
<br />
Ces attributs doivent contenir au moins une fois un code numéroté tel que <code>$1</code>, <code>$2</code>, <code>$3</code> … <code>$6</code>, qui permettra d'être remplacé par la numérotation du niveau concerné.<br />
<br />
'''Exemple''' : le format “<code>$1)</code>“ s'affichera “''A)''”, "''B)''", "''C)''" etc. (s'il est combiné au style <code>"upper-alpha"</code>), ou "i)", "ii)", "iii)" (style <code>"lower-roman"</code>). <br />
<br />
'''Autre exemple''' : “<code>Article $1.$2</code>“ s'affichera “Article 1.A”, "Article 1.B", "Article 2.A" … (combiné avec un niveau 1 au style <code>décimal</code> et un niveau 2 en <code>upper-roman</code>). <br />
<br />
'''Exemple complet :'''<br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
D'après la configuration de l'image ci-dessus, les titres :<br />
* de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”<br />
* de niveau 2 seront de la forme : “2 Lorem ipsum ”<br />
* de niveau 3 seront de la forme : “2-5 Lorem ipsum ”<br />
* de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”<br />
* de niveau 5 seront de la forme : “a. Lorem ipsum ”<br />
* de niveau 6 seront de la forme : “ iv ) Lorem ipsum<br />
<br />
=== List-Labels ===<br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
== Contenu, options, styles, [[Conditions|visible ifs]], commentaires ==<br />
<br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivantes sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span,<br />
* br<br />
<br />
</p> </br><br />
<h4 id="bases">Avertissement sur l'utilisation des balises HTML </h4><br />
<p>Veuillez prendre en compte qu'une fois que le système détecte qu'un [[Élément_de_contenu|éléments de contenu]] utilise directement une ou plusieurs balises HTML, l'ensemble de l'élément de contenu est converti au format HTML.</p><br />
<p>En conséquence, l'élément de contenu concerné ne peut <b>plus prendre en compte tout autre élément de mise en forme non-HTML</b>.</p> </br><br />
Par exemple, un saut de ligne inséré à l'aide de la combinaison ALT + ENTREE ne sera plus pris en compte dans cet élément de contenu. Il conviendra alors d'utiliser la balise </br> pour sauter une ligne.<br />
<br />
==== Contenu spécial ou dynamique ====<br />
<br />
Ils sont de la forme <code>{ @… }</code> et s'integre parmi le contenu. <br />
<br />
:: — <code>{ @line-break }</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> <br />
<br />
:: — <code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.<br />
:: Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.<br />
<br />
:: — <code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
:::: Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
:::: Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
:::: Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
<br />
:::: Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
:::: Exemple : ''Comme décrit dans la section'' <code>{@ref:droit-acheteur:uppercase}</code>.<br />
:::: Le traitement <code>:num</code> peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
:::: Exemple : ''Comme décrit dans la section ''<code>{@ref:droit-acheteur:num}</code>… => ''Comme décrit dans la section '' '''3.1.1.2'''<br />
<br />
:::: Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
:::: Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<br />
:: — <code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code><br />
<br />
:: — <code>{ @doc-meta(title) }</code> : permet d'insérer une méta-donnée du document courant. Les 3 paramètres possibles sont : <code>title</code>, <code>description</code>, ou <code>id</code>. Pratique, par exemple, pour citer le titre du document au sein du contenu, malgré peut-être la présence d'un clausier et de blocs injectés d'un autre document.<br />
<br />
==== Comment rendre dynamique le contenu d'un [[SmartDoc]] ? ====<br />
<br />
Pour rendre dynamique le contenu du SmartDoc, il est possible de lui intégrer les valeurs des variables telles qu'elles ont été collectée dans un formulaire, ou calculée via une variable dynamique etc. <br />
<br />
La syntaxe pour intégrer un contenu dynamique est reconnaissable car il est systématiquement placé entre accolades : <code>{ … }</code>.<br />
<br />
Une variable peut être intégrée de façon brute (Exemple : ''"Je m'appelle { PRENOM }."'').<br />
L'affichage brut pouvant parfois être trop limitatif, une syntaxe de "traitements SmartDoc" est disponible. Par exemple, le traitement <code>:uppercase</code> appliqué sur une variable la fera afficher en majuscule. Exemple :: ''"Je m'appelle <code>{ PRENOM:uppercase }</code>."'').<br />
<br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<br />
==== Les traitements dans le SmartDoc ==== <br />
<br />
<p>Les traitements peuvent être définies comme une modification appliquée sur un contenu. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong>L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<br />
==== Traitements disponibles et syntaxe spécifique ==== <br />
<br />
<p><code>:uppercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en majuscule</p><br />
<br/><br />
<p><code>:lowercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en minuscule</p><br />
<br/><br />
<p><code>:letters</code> : ne s'applique que sur une valeur numérique, et permet de la convertir en "toutes-lettres" (ex : <code>312</code> => <code>Trois-cent-douze</code>).</p><br />
<br/><br />
<p><code>:capitalize</code> : ne s'applique que sur une chaine de caractères, et permet de passer en majuscule la première lettre de chaque mot. Ex: <code>NOM:capitalize</code><br/><br />
Option : si l'option 1 (ou "yes") est passée en paramètre de ce traitement, alors seule la première lettre du premier mot sera mise en majuscule. Ex: <code>NOM:capitalize(1)</code> , <code>NOM:capitalize(yes)</code>… </p><br />
<br/><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document. Ex : <code>{"https://api.memegen.link/images/puffin.jpg":img}</code> va permettre d'intégrer l'image présente à cette URL dans le document.<br />
<br><i><b>Nb:</b></i> dans les version v0.9-v0.11 l'intégration d'une image distante (via <code>:img</code>) n'est plus possible dans les exports .docx / .pdf si un modèle de document (voir <i>docx template</i>) est utilisé. En effet, la norme DocX ne permet pas/plus l'intégration d'image / objet si le fichier est créé par un TemplateEngine. <br />
</p><br />
<br/><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<br/><br />
<p><code>:french-datetime</code> : ne s'applique que sur une date ou une chaîne de caractère au format "Date". Ce traitement permet de transformer la date au format "30/12/1985 à 12h45".</p><br />
<br/><br />
<p><code>:french-date</code> : ne s'applique que sur une date ou une chaîne de caractère au format "YYYY-MM-DD" (format international). Ce traitement permet de transformer la date fournie dans le format Français "jj/mm/aaaa". Depuis la version v0.10, ce filtre est "facultatif" car il est appliqué par défaut sur les dates ou les chaînes au format de date. </p><br />
<br/><br />
<p><code>:num-format</code> : ne s'applique que sur une valeur numérique, et permet de la formater pour son affichage. Ce traitement peut prendre 3 paramètres '''facultatifs'''. <br/><br />
<ul><br />
<li>Le 1er permet (numérique et facultatif) permet d'indiquer le nombre de décimale souhaitées (par défaut, 2 chiffres ou 0 si la partie décimale est nulle).</li><br />
<li>Le second paramètre (chaîne, facultative) correspond au séparateur des milliers (par défaut : un espace).</li><br />
<li>Le troisième paramètre (chaîne, facultative) correspond au caractère à afficher pour le séparateur décimal (par défaut : <code>,</code>).</li><br />
</ul><br />
Quelques exemples : <ul><br />
<li> - soit une variable numérique VAR_PI qui vaut <code>3,1451</code>. L'affichage par défaut <code>{ VAR_PI }</code> affichera <code>3,14</code>. <br/> L'affichage <code>{ VAR_PI:num-format(3) }</code> affichera <code>3,145</code>. </li><br />
<li> - pour la variable PRICE (numérique) qui vaudrait <code>9 999,99</code>, l'affichage <code>{ PRICE:num-format }</code> affichera <code>9 999,99</code> (dans ce cas le `:num-format` est facultatif). <br/>Par contre, l'affichage <code>{ PRICE:num-format(1,',', '.') }</code> affichera <code>9,999.9</code> (1 chiffre après la virgule, séparateur des milliers et décimaux modifiés).</li><br />
</ul><br />
</p><br />
<br/><br />
<br />
<br />
<code>:join</code> : limité à une variable de liste plate (issue d'un [[Fields-Form|multiples-choices]] principalement) → permet d'afficher les différentes valeurs de la liste sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code>. <br />
:: Il est possible de personnaliser le séparateur, par exemple <code>LIST:join(" ou ")</code> → renvoie <code>Valeur1 ou Valeur2 ou Valeur3</code>.<br />
:: Et il est même possible de personnaliser indépendamment le séparateur du dernier élément grâce à un second paramètre. Exemple <code>LIST:join(" ou ", " ou bien même ")</code> → renvoie <code>Valeur1 ou Valeur2 ou bien même Valeur3</code>. <br />
<br />
<br />
<br/><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<br/><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<br/><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
</p><br />
<br />
<br/><br />
<p><code>:string-replace([remplaceur], [remplacé])</code> : permet de remplacer une chaîne par une autre chaîne dans le contenu d'une variable de type "string". <br />
Par exemple pour une variable VAR qui vaudrait "Damien", l'expression <code>VAR:string-replace("F", "D")</code> donnera "Famien". <br/><br />
Si le paramètre "remplacé" n'est pas fourni, ce sera par défaut un saut de ligne qui sera recherché. Par exemple pour une variable ADDRESS qui contient des sauts de ligne, l'expression <code>ADDRESS:string-replace(", ")</code> va remplacer chaque saut de ligne de l'adresse par <code>, </code> ce qui permet de passer un texte multi-lignes dans un format une-ligne. <br/><br />
A savoir : un saut de ligne se note <code>"\n"</code>, il est donc aussi possible de remplacer, par exemple, des tirets <code>-</code> par des sauts de ligne avec l'expression <code>ADDRESS:string-replace("\n", "-")</code>.<br />
</p><br />
<br />
<br/><br />
<br />
<p><code>:default("texte par défaut")</code> permet de définir une valeur "par défaut" à afficher dans le SmartDoc si la variable sur laquelle le filtre est appliqué est vide.</p><br />
<br />
<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<br />
=== Styles ===<br />
<br />
La colonne Styles est facultative, et permet de personnaliser les styles de la ligne de contenu concernée. <br />
<br />
Les styles sont fournies dans un format inspiré de la norme [https://www.w3schools.com/css CSS] (mais fortement simplifiée).<br />
Ce format permet de définir plusieurs instructions stylistiques, chacune se terminant par un point-virgule (<code>;</code>) et un saut de ligne. Exemple d'une cellule dont le texte devra être en taille 18px et dans la couleur rouge (''#FF0000'' en couleur hexadécimale) : <br />
font-size:18px; <br />
color:#FF0000;<br />
<br />
Chaque instruction est donc formée : d'un attribut de style (voir la liste ci-dessous), puis d'un séparateur (caractère <code>:</code>), puis de la valeur du style souhaité, et se termine par un point-virgule (<code>;</code>) et un saut de ligne. <br />
Il est autorisé de placer un espace après le séparateur "<code>:</code>" mais attention à ce que ce espace ne soit pas "particulier" (espace insécable etc.) car cela mettrait en danger l'interprétation du style et il se peut qu'il ne soit pas du tout pris en compte.<br />
<br />
Les instructions de styles autorisées sont : <br />
<br />
:: '''Définir une police de caractère spécifique :'''<br />
:::: L'attribut “<code>font-family</code>” permet de spécifier la police à utiliser. <br />
:::: Plusieurs noms de police peuvent être proposées (dans l'ordre de priorité). Si le lecteur (navigateur, logiciel de traitement de texte…) utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...<br />
:::: Exemple : <code>font-family:Times New Roman, Times;</code><br />
:::: Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité. Le cas échéant, on utilisera "Times".<br />
<br />
:: '''Définir la taille du texte'''<br />
:::: <code>font-size:14px;</code><br />
:::: Dans cet exemple, la taille du texte sera forcée à 14px. <br />
<br />
:: '''Italique :''' <br />
:::: <code>font-style:italic;</code><br />
<br />
:: '''Gras :'''<br />
:::: <code>font-weight:bold</code><br />
<br />
:: '''Souligner le texte :'''<br />
:::: <code>text-decoration:underline;</code></p><br />
<br />
:: '''Alignement :'''<br />
:::: <code>text-align:right;</code> (aligner à droite)<br />
:::: <code>text-align:left;</code> (aligner à gauche)<br />
:::: <code>text-align:center</code> (centrer sur la page)<br />
:::: <code>text-align:justify</p></code> (justifier)<br />
<br />
NOTE : ''la suite est à finaliser et mettre au propre''<br />
<br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
<br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<br />
=== Visible if ===<br />
<br />
Ici, les [[Conditions|visible ifs]] permettront de conditionner l’apparition des contenus dans le Document.<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]].<br />
<br />
'''Particularité :''' les [[Conditions|visible ifs]] des SmartDocs peuvent utiliser la variable spéciale <code>_CURRENT_DOC_ID</code> (type ''string'') qui contient l'identifiant du document courant.<br />
<br />
=== Utiliser les [[Boucles]] ===<br />
Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]].<br />
<br />
=== Commentaire ===<br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1165Fields-Form2022-10-12T10:23:26Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisées pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
::* '''no-labels''' : permet de masquer le label et le possible sub-label ;<br />
<br />
::* '''top-separator''' : permet de rajouter une ligne grise (séparateur) au dessus du champ marqué avec cette classe ;<br />
<br />
::* '''bottom-separator''' : semblable à <code>top-separator</code>, cette classe permet de rajouter une ligne grise (séparateur) au dessous du champ marqué avec cette classe ;<br />
<br />
::* '''grey-label''' : permet de forcer la couleur "grise" sur le label du champ, lui donnant une importance secondaire ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
==== Principes de fonctionnement ====<br />
<br />
L'option "default" s'applique sur les champs de formulaire (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". <br />
La valeur saisie par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). <br />
La valeur par défaut, si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
==== Syntaxes ====<br />
<br />
:: — La syntaxe simple est l'option nommée ''''default'''' qui attend une valeur primitive (une chaîne, un nombre…). Exemple : <code>default: coucou</code>. <br />
:: Si le champ est "vide", il sera donc automatiquement pré-rempli avec la valeur fournie dans cette option. Attention, il faut être cohérent avec les types de champs : par exemple, dans un champ number-input, il ne sera pas possible de mettre par défaut une valeur textuelle (ex: "coucou"). <br />
<br />
:: — La syntaxe dynamique s'utilise avec l'option nommée ''''default-expr'''' qui attend une [[SmartExpressions|SmartExpression]] permettant de fournir la valeur par défaut du champ. <br />
:: Exemple : <code>default-expr: VAR + 12</code>. <br />
:: La SmartExpression peut être composée de diverses variables (dynamiques ou pas), et peut aussi utiliser la variable d'un contexte répétée si le champ en question se trouve dans une section répétée.<br />
:: Par exemple: <code>default-expr: get_value(LIST_JOUET_PREFÉRÉ, ENFANTS._KEY)</code>. <br />
:: Si le champ est "vide", il sera donc automatiquement pré-rempli avec la valeur de la variable fournie. Attention, il faut être cohérent avec les types de champ : par exemple, sur un champ ''number-input'', il ne faut pas utiliser une SmartExpression qui renverrait une valeur de type chaîne ou une liste car ce sont des formats impossibles à affciher dans un champ numérique. Si ce cas à lieu, le champ restera vide, sans valeur par défaut.<br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Docx-template&diff=1164Docx-template2022-10-06T07:44:22Z<p>Léo : </p>
<hr />
<div><h1 id="docxtemp">Docx-template</h1><br />
<h2 id="introduction">Introduction</h2><br />
<h3 id="debut">Principe</h3><br />
<p>Un docx-template constitue la base Word d'un [[SmartDoc]].</p><br />
<p>Tout Smartdoc, avant de devenir un fichier Word (docx), est d'abord traité en HTML par le système puis injecté dans un docx-template.</p><br />
<p>Si aucun docx-template n'est spécifié dans le paramétrage du SmartDoc, le système crée automatiquement un docx-template dans lequel il injecte la totalité du SmartDoc.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 23.16.58.png|700px|thumb|néant|Fonctionnement schématisé d'injection entre un SmartDoc et son Docx-template]]<br />
<h3 id="debut">Intérêt et avantages</h3><br />
<p>L'avantage principal lié au fait de préciser un Docx-template dans le paramétrage est de pouvoir personnaliser totalement le fichier Docx qui fera office de docx-template : styles des titres, interlignes, pied de page, en-tête, filigrane, page de garde stylisé, etc ...</p><br />
<p>Le second avantage, de manière générale, est de pouvoir profiter de toutes les fonctionnalités les plus avancées de Word : tableaux, retraits, etc ...</p><br />
<p>Enfin, à l'instar des [[SmartDocX]], les docx-template peuvent aussi accueillir directement des variables, inscrites de la manière suivante : <code>${MA_VARIABLE}</code></p><br />
<h2 id="parametrage">Mise en place d'un docx-template dans le fichier de paramétrage</h2><br />
<h3 id="doclist">Paramétrage dans la DocList</h3><br />
<p>La [[DocList]] doit prévoir le fait que le [[SmartDoc]] correspondant va bénéficier d'un docxtemplate.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 23.36.06.png|1200px|thumb|néant|Une DocList prévue pour que le SmartDoc contrat de travail se base sur un docx-template]]<br />
<h3 id="smartdoc">Paramétrage dans le SmartDoc concerné</h3><br />
<p> Le [[SmartDoc]] doit aussi prévoir, dans ses options, qu'il va bénéficier d'une docx-template.<p><br />
[[Fichier:Capture d’écran 2020-07-30 à 00.04.31.png|1200px|thumb|néant|Le SmartDoc contrat de travail prévoyant une ligne spécifique dans sa colonne Options pour pouvoir bénéficier d'un docx-template]]<br />
<br />
== Injecter du contenu dynamique dans un modèle ==<br />
<br />
Le modèle étant au format docx, son contenu est statique. <br />
Lors de la génération d'un Document, si un modèle docx est précisé, alors le contenu dynamique va pouvoir y être intégré. <br />
<br />
=== La syntaxe de l'injection dynamique dans un modèle ===<br />
<br />
Les instructions sont toujours sous la forme <code>${ … }</code>. Elles sont de 4 types : <br />
<br />
:: — une simple injection de variable (variable du Datastore ou même [[Dynvars|variable Dynamique]]). Ex : <code>${ PRENOM }</code>.<br />
:: Cette méthode d'injection est simpliste, la valeur de la variable sera injectée telle quelle, puisqu'on est dans le docx, il n'est pas possible d'appliquer des traitements à ce niveau. <br />
<br />
:: — l'injection de l'ensemble du contenu dynamique du [[SmartDoc]]) : <code>${ @inject all }</code>. <br />
:: Le contenu dynamique injecté prendra en compte les niveaux de titres, leur numérotation, et les styles configurés dans le . (voir [[Docx-template#Les styles dans le modèle docx| la rubrique sur les Styles]] ci-dessous).<br />
<br />
:: — l'injection d'un [[SmartDoc/Blocs|bloc]] spécifique du [[SmartDoc]]) : <code>${ @inject id-du-bloc }</code>. <br />
:: Si le bloc ciblé doit provenir d'une autre document que celui qui est en train d'être généré, alors il faudra préciser l'identifiant de cet autre document avec la syntaxe suivante : <code>${ inject @id-du-doc:id-du-bloc }</code>. <br />
<br />
:: — l'injection d'une métadonnée du [[SmartDoc]], telle que son titre : <code>${ @doctitle }</code>. Le titre d'un document est celui qui est configuré dans la [[DocList]].<br />
<br />
<br />
=== Les styles dans le modèle docx ===<br />
<br />
Pour bien personnaliser les styles des modèles, il est important de bien maîtriser son logiciel de traitement de texte et de toujours bien sauvegarder le modèle au format <code>.docx</code>.<br />
<br />
Le style par défaut appliqué aux paragraphes injectés est généralement nommé "Normal" chez Microsoft Word ou LibreOffice. En modifiant la couleur, la taille (ou tout autre propriété) de ce Style dans le fichier de modèle, alors le contenu injecté utilisera automatiquement la mise en forme choisie dans le document généré.<br />
<br />
Les styles qui seront appliqués sur les titres du document sont des styles de titre proposés par défaut dans la norme ''.docx''. <br />
Sous Microsoft Word, ils sont nommés "Titre 1", "Titre 2" etc. , mais dans la version Anglaise du logiciel, ils seront nommés "Header 1", "Header 2" …</div>Léohttps://wiki.hercule.co/index.php?title=Treatment&diff=1163Treatment2022-10-06T07:43:24Z<p>Léo : </p>
<hr />
<div>= Introduction =<br />
<br />
[[File:Exemple-traitements.png|thumb|droite|400px|Exemple d'une table de traitements avec différents types d'instruction (et des commentaires explicatifs).]]<br />
<br />
Une table de traitement est un liste d'instruction qui peuvent s'appliquer sur un Dataset, permettant de transformer les données existantes.<br />
Les traitements sont déclenchés manuellement par l'application (via un Thème par exemple).<br />
<br />
Une Configuration peut définir plusieurs table de traitements, chacune ayant un identifiant unique (une chaîne de caractère, sans espace).<br />
<br />
Les instructions de la table de traitement sont exécutés dans l'ordre de le lecture.<br />
<br />
= Types d'instructions de traitement =<br />
<br />
Il existe plusieurs "types" d'instructions de traitement :<br />
<br />
<br />
:: — <code>set</code>. Instruction la plus élémentaire, elle consiste à '''assigner une nouvelle valeur''' à une variable à partir d'une SmartExpression fournie. La SmartExpression peut faire appel à d'autres variables du Dataset, mais aussi à d'éventuelles [[Variables_dynamiques_(DynVars)|DynVars]]. Ce type d'assignation ne peut s'appliquer que sur une variable simple (de premier niveau). <br />
:::: - Voir [[Media:Treat-ex-set-1.png|exemple illustré n°1]].<br />
:::: - Voir [[Media:Treat-ex-set-2.png|exemple illustré n°2]].<br />
<br />
<br />
:: — <code>unset</code> '''Forcer à null la valeur d'une variable'''. À l'inverse de l'instruction précédente, cette instruction permet de "vider" la valeur de la variable spécifiée. Si cette instruction est appliquée sur une variable de type "liste" alors la liste sera vidée de tous ses éléments (sous-variables etc.).<br />
:::: - Voir [[Media:Treat-ex-unset.png|exemple illustré]].<br />
<br />
<br />
:: — <code>set-all</code>. '''L'assignation multiple''' consiste à assigner une valeur à une sous-variable, pour TOUS les éléments d'une liste. La valeur est calculée à partir d'une SmartExpression qui peut faire appel à d'autres variables du Dataset, ainsi qu'à d'éventuelles [[Variables_dynamiques_(DynVars)|DynVars]]. La sous-variable ciblée est indiquée sous la forme de sa définition (Ex: ''EMPLOYÉS.DATE_ENTRÉE''). <br />
:::: - Voir [[Media:Treat-ex-setall-1.png|exemple illustré n°1]].<br />
:::: - Voir [[Media:Treat-ex-setall-2.png|exemple illustré n°2]].<br />
<br />
<br />
:: — <code>add-in-list</code>. '''L'ajout ou la mise à jour d'un élément spécifique dans une liste'''. Pour une variable de liste (Ex: EMPLOYÉS), ce type d'instruction permet d'ajouter une nouvelle entrée dans la liste et de définir sa valeur et celle de toutes ses potentielles sous-variables. <br />
<br />
:::: Par défaut, si aucune clé n'est définie, un nouvel élément est rajouté dans la liste. <br />
<br />
:::: Si une SmartExpression est fournie, et que sa valeur correspond à la clé d'un élément existant de la liste, alors cet élément sera ciblé et mis-à-jour au lieu qu'un nouvel élément soit rajouté à la fin de la liste. <br />
<br />
:::: Dans le cas d'une Liste Structurée (ex: EMPLOYÉS), les lignes suivantes dans la table permettront de définir la valeur à assigner aux sous-variables. Elles seront indiquée sous une forme simplifiée, sans re-citer la variable de liste, et donc reconnaissable car débutant par un "." (ex: <code>.DATE_ENTRÉE</code> pour définir la valeur de <code>EMPLOYÉ.DATE_ENTRÉE</code>).<br />
<br />
:::: Dans le cas d'une Liste Plate (ex: LIST_COULEURS), qui n'a pas de sous-variables par nature, il faudra utiliser la syntaxe <code>._VALUE</code> pour définir la valeur à rajouter dans la liste. <br />
<br />
:::: - Voir [[Media:Treat-ex-add-1.png|exemple illustré n°1]] (ajout).<br />
:::: - Voir [[Media:Treat-ex-add-2a.png|exemple illustré n°2]] (remplacement).<br />
:::: - Voir (@TODO) (ajout liste plate).<br />
<br />
<br />
:: — <code>remove</code> '''Le retrait d'un élément dans une liste'''. Pour une variable de liste (Ex: EMPLOYÉS), ce type d'instruction permet de supprimer une entrée en fonction d'une clé fournie au travers de la SmartExpression. <br />
:::: Si la SmartExpression renvoie une liste plate de clés, alors chacune des clés citée seront retirées (si elles existent dans la liste bien sûr). Cela permet d'effectuer une suppression "multiple". <br />
:::: - Voir [[Media:Treat-ex-remove.png|exemple illustré]] (suppression).<br />
<br />
<br />
:: — <code>merge</code> '''La fusion d'une liste sur une autre liste'''. La variable ciblée, de type "liste", se verra fusionnée à la liste renvoyée par la SmartExpression. Les valeurs indiquées dans cette dernière viendront donc remplacer les valeurs existantes dans la liste ciblée. De plus, si une des deux listes contient des éléments que l'autre liste ne connait pas (identifiés par leurs clés), alors ils seront rajoutés au résultat. <br />
:::: Dans le cas de listes structurées, il est bien entendu nécéssaire que les deux listes soient similaires au niveau des définitions de leurs sous-variables. En effet, si la liste 2 définie des sous-variables qui n'existent pas dans la liste 1, après la fusion, la liste 1 va se retrouver avec des variables qu'elle ne connait pas, et cela posera un problème d'intégrité résultant en une erreur (fusion nulle). <br />
::: - Voir exemple illustré (@TODO).<br />
<br />
<br />
:: — <code>merge-through-key</code> '''La fusion d'une liste 1 sur une liste 2, au travers d'une clé spécifiée dans la liste 2'''. Très similaire à l'instruction de fusion précédente, ce type de traitement permet de spécifier la clé de fusion de chaque élément. <br />
:::: La clé de fusion est indiquée avec la syntaxe <code>through key SUBVAR</code>, où <code>SUBVAR</code> est une sous-variable de la liste 2, ayant pour valeur une clé de la liste 1. Ce type de fusion est particulièrement utile dans le cas d'une mise à jour ciblée des éléments d'une liste.<br />
:::: - Voir [[Media:Treat-ex-merge-through-key.png|exemple illustré]] (exemple avec cumul de traitement). Dans l'exemple illustré, prenez note du retour chariot (obligatoire) entre "EMPLOYÉS" et "through".</div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=1146SmartDoc2022-05-03T14:11:55Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
<h3 id="Métadonnées">Métadonnées</h3><br />
<p> C'est un simple espace de commentaire </p><br />
<h3 id="Datastore">DataStore</h3><br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<h3 id="title-num-display">Options - title-num-display</h3><br />
<p>title-num-display : cette colonne permet de définir le format d’affichage pour la numérotation de chaque titre du document. Cette option attend un tableau, où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, deux attributs à configurer : style et format .</p><br />
<p><strong>Les valeurs possible pour les attributs style sont :</strong><br />
<p>&quot;upper-roman&quot; : nombre romain majuscule (I, II, III, IV etc...)</p> <br />
<p>&quot;decimal&quot; : numérotation décimale / chiffres arabes (1, 2 , 3 ...)</p><br />
<p>&quot;lower-roman&quot; : nombre romain minuscule (i, ii, iii, iv etc.)</p><br />
<p>&quot;lower-alpha” : numérotation alphabétique minuscule (a, b, c, d...)</p><br />
<p>&quot;upper-alpha&quot; : numérotation alphabétique majuscule (A, B, C, D, E)</p><br />
<p><strong>En ce qui concerne l’attributs format :</strong><br />
Il attend une chaîne de caractère dans laquelle $1, $2, $3 … $6 seront remplacés par la numérotation (au style attribué). <br />
Exemple : “Article $1.$2” peut donner “Article 3.a”.</p><br />
<p><strong>Exemple complet :</strong></p><br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
<p>Où les titres :</p><br />
<p>de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”</p><br />
<p>de niveau 2 seront de la forme : “2 Lorem ipsum ”</p><br />
<p>de niveau 3 seront de la forme : “2-5 Lorem ipsum ”</p><br />
<p>de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”</p><br />
<p>de niveau 5 seront de la forme : “a. Lorem ipsum ”</p><br />
<p>de niveau 6 seront de la forme : “ iv ) Lorem ipsum”</p><br />
<h3 id="List-Labels">List-Labels</h3><br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
== Contenu, options, styles, [[Conditions|visible ifs]], commentaires ==<br />
<br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivants sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span<br />
</p><br />
<br />
==== Contenu spécial ou dynamique ====<br />
<br />
Ils sont de la forme <code>{ @… }</code> et s'integre parmi le contenu. <br />
<br />
:: — <code>{ @line-break }</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> <br />
<br />
:: — <code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.<br />
:: Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.<br />
<br />
:: — <code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
:::: Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
:::: Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
:::: Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
<br />
:::: Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
:::: Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:uppercase}</code>.<br />
:::: Le traitement <code>:num</code> peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
:::: Exemple : ''Comme décrit dans la section ''<code>{@ref:droit-acheteur:num}</code>… => ''Comme décrit dans la section '' '''3.1.1.2'''<br />
<br />
:::: Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
:::: Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<br />
:: — <code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code><br />
<br />
:: — <code>{ @doc-meta(title) }</code> : permet d'insérer une méta-donnée du document courant. Les 3 paramètres possibles sont : <code>title</code>, <code>description</code>, ou <code>id</code>. Pratique, par exemple, pour citer le titre du document au sein du contenu, malgré peut-être la présence d'un clausier et de blocs injectés d'un autre document. <br />
<br />
==== Comment rendre dynamique le contenu d'un [[SmartDoc]] ? ====<br />
<br />
Pour rendre dynamique le contenu du SmartDoc, il est possible de lui intégrer les valeurs des variables telles qu'elles ont été collectée dans un formulaire, ou calculée via une variable dynamique etc. <br />
<br />
La syntaxe pour intégrer un contenu dynamique est reconnaissable car il est systématiquement placé entre accolades : <code>{ … }</code>.<br />
<br />
Une variable peut être intégrée de façon brute (Exemple : ''"Je m'appelle { PRENOM }."'').<br />
L'affichage brut pouvant parfois être trop limitatif, une syntaxe de "traitements SmartDoc" est disponible. Par exemple, le traitement <code>:uppercase</code> appliqué sur une variable la fera afficher en majuscule. Exemple :: ''"Je m'appelle <code>{ PRENOM:uppercase }</code>."'').<br />
<br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<br />
==== Les traitements dans le SmartDoc ==== <br />
<br />
<p>Les traitements peuvent être définies comme une modification appliquée sur un contenu. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong>L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<br />
==== Traitements disponibles et syntaxe spécifique ==== <br />
<br />
<p><code>:uppercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en majuscule</p><br />
<br/><br />
<p><code>:lowercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en minuscule</p><br />
<br/><br />
<p><code>:letters</code> : ne s'applique que sur une valeur numérique, et permet de la convertir en "toutes-lettres" (ex : <code>312</code> => <code>Trois-cent-douze</code>).</p><br />
<br/><br />
<p><code>:capitalize</code> : ne s'applique que sur une chaine de caractères, et permet de passer en majuscule la première lettre de chaque mot. Ex: <code>NOM:capitalize</code><br/><br />
Option : si l'option 1 (ou "yes") est passée en paramètre de ce traitement, alors seule la première lettre du premier mot sera mise en majuscule. Ex: <code>NOM:capitalize(1)</code> , <code>NOM:capitalize(yes)</code>… </p><br />
<br/><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document. Ex : <code>{"https://api.memegen.link/images/puffin.jpg":img}</code> va permettre d'intégrer l'image présente à cette URL dans le document.<br />
<br><i><b>Nb:</b></i> dans les version v0.9-v0.11 l'intégration d'une image distante (via <code>:img</code>) n'est plus possible dans les exports .docx / .pdf si un modèle de document (voir <i>docx template</i>) est utilisé. En effet, la norme DocX ne permet pas/plus l'intégration d'image / objet si le fichier est créé par un TemplateEngine. <br />
</p><br />
<br/><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<br/><br />
<p><code>:french-datetime</code> : ne s'applique que sur une date ou une chaîne de caractère au format "Date". Ce traitement permet de transformer la date au format "30/12/1985 à 12h45".</p><br />
<br/><br />
<p><code>:french-date</code> : ne s'applique que sur une date ou une chaîne de caractère au format "YYYY-MM-DD" (format international). Ce traitement permet de transformer la date fournie dans le format Français "jj/mm/aaaa". Depuis la version v0.10, ce filtre est "facultatif" car il est appliqué par défaut sur les dates ou les chaînes au format de date. </p><br />
<br/><br />
<p><code>:num-format</code> : ne s'applique que sur une valeur numérique, et permet de la formater pour son affichage. Ce traitement peut prendre 3 paramètres '''facultatifs'''. <br/><br />
<ul><br />
<li>Le 1er permet (numérique et facultatif) permet d'indiquer le nombre de décimale souhaitées (par défaut, 2 chiffres ou 0 si la partie décimale est nulle).</li><br />
<li>Le second paramètre (chaîne, facultative) correspond au séparateur des milliers (par défaut : un espace).</li><br />
<li>Le troisième paramètre (chaîne, facultative) correspond au caractère à afficher pour le séparateur décimal (par défaut : <code>,</code>).</li><br />
</ul><br />
Quelques exemples : <ul><br />
<li> - soit une variable numérique VAR_PI qui vaut <code>3,1451</code>. L'affichage par défaut <code>{ VAR_PI }</code> affichera <code>3,14</code>. <br/> L'affichage <code>{ VAR_PI:num-format(3) }</code> affichera <code>3,145</code>. </li><br />
<li> - pour la variable PRICE (numérique) qui vaudrait <code>9 999,99</code>, l'affichage <code>{ PRICE:num-format }</code> affichera <code>9 999,99</code> (dans ce cas le `:num-format` est facultatif). <br/>Par contre, l'affichage <code>{ PRICE:num-format(1,',', '.') }</code> affichera <code>9,999.9</code> (1 chiffre après la virgule, séparateur des milliers et décimaux modifiés).</li><br />
</ul><br />
</p><br />
<br/><br />
<br />
<br />
<code>:join</code> : limité à une variable de liste plate (issue d'un [[Fields-Form|multiples-choices]] principalement) → permet d'afficher les différentes valeurs de la liste sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code>. <br />
:: Il est possible de personnaliser le séparateur, par exemple <code>LIST:join(" ou ")</code> → renvoie <code>Valeur1 ou Valeur2 ou Valeur3</code>.<br />
:: Et il est même possible de personnaliser indépendamment le séparateur du dernier élément grâce à un second paramètre. Exemple <code>LIST:join(" ou ", " ou bien même ")</code> → renvoie <code>Valeur1 ou Valeur2 ou bien même Valeur3</code>. <br />
<br />
<br />
<br/><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<br/><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<br/><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
</p><br />
<br />
<br/><br />
<p><code>:string-replace([remplaceur], [remplacé])</code> : permet de remplacer une chaîne par une autre chaîne dans le contenu d'une variable de type "string". <br />
Par exemple pour une variable VAR qui vaudrait "Damien", l'expression <code>VAR:string-replace("F", "D")</code> donnera "Famien". <br/><br />
Si le paramètre "remplacé" n'est pas fourni, ce sera par défaut un saut de ligne qui sera recherché. Par exemple pour une variable ADDRESS qui contient des sauts de ligne, l'expression <code>ADDRESS:string-replace(", ")</code> va remplacer chaque saut de ligne de l'adresse par <code>, </code> ce qui permet de passer un texte multi-lignes dans un format une-ligne. <br/><br />
A savoir : un saut de ligne se note <code>"\n"</code>, il est donc aussi possible de remplacer, par exemple, des tirets <code>-</code> par des sauts de ligne avec l'expression <code>ADDRESS:string-replace("\n", "-")</code>.<br />
</p><br />
<br />
<br/><br />
<br />
<p><code>:default("texte par défaut")</code> permet de définir une valeur "par défaut" à afficher dans le SmartDoc si la variable sur laquelle le filtre est appliqué est vide.</p><br />
<br />
<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<h3 id="styles">Styles</h3><br />
<p>La colonne Styles est facultative, et permet de traiter différemment le contenu de la ligne concernée. </p><br />
<p>A chaque traitement utilisé, on retournera à la ligne après avoir écrit un <code>;</code></p><br />
*Définir la police :<br />
<p>Le traitement “<code>font-family</code>” permet de spécifier la police utilisée. </p><br />
<p>Ce traitement peut prévoir plusieurs polices, comme un système à plusieurs détentes : si le navigateur utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...</p><br />
<p>Exemple : </p><br />
<p> <code>font-family: Times New Roman, Times, serif;</code><br />
<p>Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité.</p><br />
<p>Si le navigateur ne supporte pas cette police, on cherchera à afficher une police de la famille “Times”.</p><br />
<p>Enfin, si rien de tout cela ne marche, on cherchera à afficher une police de type “Serif”</p><br />
*Définir la taille de la police : </p><br />
<p><code>font-size: XXpt;</code><br />
<p>On remplacera XX par la taille de police souhaitée</p><br />
*Mettre en gras :<br />
<code>font-weight: bold</code></p><br />
*Mettre en italique : <br />
<code>font-style: italic;</code></p><br />
*Souligner le texte : <br />
<code>text-decoration: underline;</code></p><br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
*Aligner le texte</p><br />
<p><code>text-align: right</code><br />
<code>text-align: left</code><br />
<code>text-align: center</code><br />
<code>text-align: justify</p></code></p><br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<h3 id="visible-if">[[Conditions|Visible if]]</h3><br />
<p>Ici, les [[Conditions|visible ifs]] permettront de conditionner logiquement l’apparition du texte se trouvant dans la colonne “Contenu”<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]]</p><br />
<h3 id="utiliser-les-loops-boucles-">Utiliser les [[Boucles]]</h3><br />
<p>Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]]</p><br />
<h3 id="commentaire">Commentaire</h3><br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=1145SmartDoc2022-05-03T14:11:20Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
<h3 id="Métadonnées">Métadonnées</h3><br />
<p> C'est un simple espace de commentaire </p><br />
<h3 id="Datastore">DataStore</h3><br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<h3 id="title-num-display">Options - title-num-display</h3><br />
<p>title-num-display : cette colonne permet de définir le format d’affichage pour la numérotation de chaque titre du document. Cette option attend un tableau, où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, deux attributs à configurer : style et format .</p><br />
<p><strong>Les valeurs possible pour les attributs style sont :</strong><br />
<p>&quot;upper-roman&quot; : nombre romain majuscule (I, II, III, IV etc...)</p> <br />
<p>&quot;decimal&quot; : numérotation décimale / chiffres arabes (1, 2 , 3 ...)</p><br />
<p>&quot;lower-roman&quot; : nombre romain minuscule (i, ii, iii, iv etc.)</p><br />
<p>&quot;lower-alpha” : numérotation alphabétique minuscule (a, b, c, d...)</p><br />
<p>&quot;upper-alpha&quot; : numérotation alphabétique majuscule (A, B, C, D, E)</p><br />
<p><strong>En ce qui concerne l’attributs format :</strong><br />
Il attend une chaîne de caractère dans laquelle $1, $2, $3 … $6 seront remplacés par la numérotation (au style attribué). <br />
Exemple : “Article $1.$2” peut donner “Article 3.a”.</p><br />
<p><strong>Exemple complet :</strong></p><br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
<p>Où les titres :</p><br />
<p>de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”</p><br />
<p>de niveau 2 seront de la forme : “2 Lorem ipsum ”</p><br />
<p>de niveau 3 seront de la forme : “2-5 Lorem ipsum ”</p><br />
<p>de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”</p><br />
<p>de niveau 5 seront de la forme : “a. Lorem ipsum ”</p><br />
<p>de niveau 6 seront de la forme : “ iv ) Lorem ipsum”</p><br />
<h3 id="List-Labels">List-Labels</h3><br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
== Contenu, options, styles, [[Conditions|visible ifs]], commentaires ==<br />
<br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivants sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span<br />
</p><br />
<br />
==== Contenu spécial ou dynamique ====<br />
<br />
Ils sont de la forme <code>{ @… }</code> et s'integre parmi le contenu. <br />
<br />
:: — <code>{ @line-break }</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> <br />
<br />
:: — <code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.<br />
:: Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.<br />
<br />
:: — <code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
:::: Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
:::: Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
:::: Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
<br />
:::: Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
:::: Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:uppercase}</code>.<br />
:::: Le traitement <code>:num</code> peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
:::: Exemple : ''Comme décrit dans la section ''<code>{@ref:droit-acheteur:num}</code>… => ''Comme décrit dans la section '' '''3.1.1.2'''<br />
<br />
:::: Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
:::: Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<br />
:: — <code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code><br />
<br />
:: — <code>{ @doc-meta(title) }</code> : permet d'insérer une méta-donnée du document courant. Les 3 paramètres possibles sont : <code>title</code>, <code>description</code>, ou <code>id</code>. Pratique, par exemple, pour citer le titre du document au sein du contenu, malgré peut-être la présence d'un clausier et de blocs injectés d'un autre document. <br />
<br />
==== Comment rendre dynamique le contenu d'un [[SmartDoc]] ? ====<br />
<br />
Pour rendre dynamique le contenu du SmartDoc, il est possible de lui intégrer les valeurs des variables telles qu'elles ont été collectée dans un formulaire, ou calculée via une variable dynamique etc. <br />
<br />
La syntaxe pour intégrer un contenu dynamique est reconnaissable car il est systématiquement placé entre accolades : <code>{ … }</code>.<br />
<br />
Une variable peut être intégrée de façon brute (Exemple : ''"Je m'appelle { PRENOM }."'').<br />
L'affichage brut pouvant parfois être trop limitatif, une syntaxe de "traitements SmartDoc" est disponible. Par exemple, le traitement <code>:uppercase</code> appliqué sur une variable la fera afficher en majuscule. Exemple :: ''"Je m'appelle <code>{ PRENOM:uppercase }</code>."'').<br />
<br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<br />
==== Les traitements dans le SmartDoc ==== <br />
<br />
<p>Les traitements peuvent être définies comme une modification appliquée sur un contenu. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong>L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<br />
==== Traitements disponibles et syntaxe spécifique ==== <br />
<br />
<p><code>:uppercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en majuscule</p><br />
<br/><br />
<p><code>:lowercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en minuscule</p><br />
<br/><br />
<p><code>:letters</code> : ne s'applique que sur une valeur numérique, et permet de la convertir en "toutes-lettres" (ex : <code>312</code> => <code>Trois-cent-douze</code>).</p><br />
<br/><br />
<p><code>:capitalize</code> : ne s'applique que sur une chaine de caractères, et permet de passer en majuscule la première lettre de chaque mot. Ex: <code>NOM:capitalize</code><br/><br />
Option : si l'option 1 (ou "yes") est passée en paramètre de ce traitement, alors seule la première lettre du premier mot sera mise en majuscule. Ex: <code>NOM:capitalize(1)</code> , <code>NOM:capitalize(yes)</code>… </p><br />
<br/><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document. Ex : <code>{"https://api.memegen.link/images/puffin.jpg":img}</code> va permettre d'intégrer l'image présente à cette URL dans le document.<br />
<br><i><b>Nb:</b></i> dans les version v0.9-v0.11 l'intégration d'une image distante (via <code>:img</code>) n'est plus possible dans les exports .docx / .pdf si un modèle de document (voir <i>docx template</i>) est utilisé. En effet, la norme DocX ne permet pas/plus l'intégration d'image / objet si le fichier est créé par un TemplateEngine. <br />
</p><br />
<br/><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<br/><br />
<p><code>:french-datetime</code> : ne s'applique que sur une date ou une chaîne de caractère au format "Date". Ce traitement permet de transformer la date au format "30/12/1985 à 12h45".</p><br />
<br/><br />
<p><code>:french-date</code> : ne s'applique que sur une date ou une chaîne de caractère au format "YYYY-MM-DD" (format international). Ce traitement permet de transformer la date fournie dans le format Français "jj/mm/aaaa". Depuis la version v0.10, ce filtre est "facultatif" car il est appliqué par défaut sur les dates ou les chaînes au format de date. </p><br />
<br/><br />
<p><code>:num-format</code> : ne s'applique que sur une valeur numérique, et permet de la formater pour son affichage. Ce traitement peut prendre 3 paramètres '''facultatifs'''. <br/><br />
<ul><br />
<li>Le 1er permet (numérique et facultatif) permet d'indiquer le nombre de décimale souhaitées (par défaut, 2 chiffres ou 0 si la partie décimale est nulle).</li><br />
<li>Le second paramètre (chaîne, facultative) correspond au séparateur des milliers (par défaut : un espace).</li><br />
<li>Le troisième paramètre (chaîne, facultative) correspond au caractère à afficher pour le séparateur décimal (par défaut : <code>,</code>).</li><br />
</ul><br />
Quelques exemples : <ul><br />
<li> - soit une variable numérique VAR_PI qui vaut <code>3,1451</code>. L'affichage par défaut <code>{ VAR_PI }</code> affichera <code>3,14</code>. <br/> L'affichage <code>{ VAR_PI:num-format(3) }</code> affichera <code>3,145</code>. </li><br />
<li> - pour la variable PRICE (numérique) qui vaudrait <code>9 999,99</code>, l'affichage <code>{ PRICE:num-format }</code> affichera <code>9 999,99</code> (dans ce cas le `:num-format` est facultatif). <br/>Par contre, l'affichage <code>{ PRICE:num-format(1,',', '.') }</code> affichera <code>9,999.9</code> (1 chiffre après la virgule, séparateur des milliers et décimaux modifiés).</li><br />
</ul><br />
</p><br />
<br/><br />
<br />
<br />
<code>:join</code> : limité à une variable de liste plate (issue d'un [[Fields-Form|multiples-choices]] principalement) → permet d'afficher les différentes valeurs de la liste sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code>. <br />
:: Il est possible de personnaliser le séparateur, par exemple <code>LIST:join(" ou ")</code> → renvoie <code>Valeur1 ou Valeur2 ou Valeur3</code>.<br />
:: Et il est même possible de personnaliser indépendamment le séparateur du dernier élément grâce à un second paramètre. Exemple <code>LIST:join(" ou ", " ou bien même ")</code> → renvoie <code>Valeur1 ou Valeur2 ou bien même Valeur3</code>. <br />
<br />
<br />
<br/><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<br/><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<br/><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
</p><br />
<br />
<br/><br />
<p><code>:string-replace([remplaceur], [remplacé])</code> : permet de remplacer une chaîne par une autre chaîne dans le contenu d'une variable de type "string". <br />
Par exemple pour une variable VAR qui vaudrait "Damien", l'expression <code>VAR:string-replace("F", "D")</code> donnera "Famien". <br/><br />
Si le paramètre "remplacé" n'est pas fourni, ce sera par défaut un saut de ligne qui sera recherché. Par exemple pour une variable ADDRESS qui contient des sauts de ligne, l'expression <code>ADDRESS:string-replace(", ")</code> va remplacer chaque saut de ligne de l'adresse par <code>, </code> ce qui permet de passer un texte multi-lignes dans un format une-ligne. <br/><br />
A savoir : un saut de ligne se note <code>"\n"</code>, il est donc aussi possible de remplacer, par exemple, des tirets <code>-</code> par des sauts de ligne avec l'expression <code>ADDRESS:string-replace("\n", "-")</code>.<br />
</p><br />
<br />
<br/><br />
<br />
<p><code>default("texte par défaut")</code></p> permet de définir une valeur "par défaut" à afficher dans le SmartDoc si la variable sur laquelle le filtre est appliqué est vide.<br />
<br />
<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<h3 id="styles">Styles</h3><br />
<p>La colonne Styles est facultative, et permet de traiter différemment le contenu de la ligne concernée. </p><br />
<p>A chaque traitement utilisé, on retournera à la ligne après avoir écrit un <code>;</code></p><br />
*Définir la police :<br />
<p>Le traitement “<code>font-family</code>” permet de spécifier la police utilisée. </p><br />
<p>Ce traitement peut prévoir plusieurs polices, comme un système à plusieurs détentes : si le navigateur utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...</p><br />
<p>Exemple : </p><br />
<p> <code>font-family: Times New Roman, Times, serif;</code><br />
<p>Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité.</p><br />
<p>Si le navigateur ne supporte pas cette police, on cherchera à afficher une police de la famille “Times”.</p><br />
<p>Enfin, si rien de tout cela ne marche, on cherchera à afficher une police de type “Serif”</p><br />
*Définir la taille de la police : </p><br />
<p><code>font-size: XXpt;</code><br />
<p>On remplacera XX par la taille de police souhaitée</p><br />
*Mettre en gras :<br />
<code>font-weight: bold</code></p><br />
*Mettre en italique : <br />
<code>font-style: italic;</code></p><br />
*Souligner le texte : <br />
<code>text-decoration: underline;</code></p><br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
*Aligner le texte</p><br />
<p><code>text-align: right</code><br />
<code>text-align: left</code><br />
<code>text-align: center</code><br />
<code>text-align: justify</p></code></p><br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<h3 id="visible-if">[[Conditions|Visible if]]</h3><br />
<p>Ici, les [[Conditions|visible ifs]] permettront de conditionner logiquement l’apparition du texte se trouvant dans la colonne “Contenu”<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]]</p><br />
<h3 id="utiliser-les-loops-boucles-">Utiliser les [[Boucles]]</h3><br />
<p>Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]]</p><br />
<h3 id="commentaire">Commentaire</h3><br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1144Fields-Form2022-05-03T14:05:09Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisées pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
::* '''no-labels''' : permet de masquer le label et le possible sub-label ;<br />
<br />
::* '''top-separator''' : permet de rajouter une ligne grise (séparateur) au dessus du champ marqué avec cette classe ;<br />
<br />
::* '''bottom-separator''' : semblable à <code>top-separator</code>, cette classe permet de rajouter une ligne grise (séparateur) au dessous du champ marqué avec cette classe ;<br />
<br />
::* '''grey-label''' : permet de forcer la couleur "grise" sur le label du champ, lui donnant une importance secondaire ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
==== Principes de fonctionnement ====<br />
<br />
L'option "default" fonctionne sur les champs de type de saisie (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". La valeur par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). Avec cette valeur par défaut, et si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, alors elle sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1076Fields-Form2022-01-21T12:13:19Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisées pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
::* '''no-labels''' : permet de masquer le label et le possible sub-label ;<br />
<br />
::* '''top-separator''' : permet de rajouter une ligne grise (séparateur) au dessus du champ marqué avec cette classe ;<br />
<br />
::* '''bottom-separator''' : semblable à <code>top-separator</code>, cette classe permet de rajouter une ligne grise (séparateur) au dessous du champ marqué avec cette classe ;<br />
<br />
::* '''grey-label''' : permet de forcer la couleur "grise" sur le label du champ, lui donnant une importance secondaire ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
==== Principes de fonctionnement ====<br />
<br />
L'option "default" fonctionne sur les champs de type de saisie (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". La valeur par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). Avec cette valeur par défaut, et si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, alors elle sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
==== Utilisation ====<br />
<br />
===== Principe =====<br />
<br />
<code>{NOM_DE_VARIABLE:default(texte par défaut)}</code><br />
<br />
===== Exemple =====<br />
<br />
<code>{PRENOM_ACHETEUR:default([Prénom de l'acheteur])}</code><br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1075Fields-Form2022-01-21T12:11:25Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisées pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
::* '''no-labels''' : permet de masquer le label et le possible sub-label ;<br />
<br />
::* '''top-separator''' : permet de rajouter une ligne grise (séparateur) au dessus du champ marqué avec cette classe ;<br />
<br />
::* '''bottom-separator''' : semblable à <code>top-separator</code>, cette classe permet de rajouter une ligne grise (séparateur) au dessous du champ marqué avec cette classe ;<br />
<br />
::* '''grey-label''' : permet de forcer la couleur "grise" sur le label du champ, lui donnant une importance secondaire ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
==== Principes de fonctionnement ====<br />
<br />
L'option "default" fonctionne sur les champs de type de saisie (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". La valeur par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). Avec cette valeur par défaut, et si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, alors elle sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
==== Utilisation ====<br />
<br />
===== Principe =====<br />
<br />
<code>{NOM_DE_VARIABLE:default(texte par défaut)</code><br />
<br />
===== Exemple =====<br />
<br />
<code>{PRENOM_ACHETEUR:default([Prénom de l'acheteur])</code><br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1056Fields-Form2021-06-10T09:17:01Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisées pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
L'option "default" fonctionne sur les champs de type de saisie (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". La valeur par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). Avec cette valeur par défaut, et si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, alors elle sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=1055Fields-Form2021-06-10T09:16:37Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Saisie numérique</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
Ce champ permet à l'utilisateur de saisir une valeur numérique, qui sera formatée comme telle (séparateurs des milliers, virgule etc.). <br/> <br />
Il est préférable que la variable associée à ce champ soit du type "numeric". De ce fait, lors de l'enregistrement du champ, une erreur sera affichée si la valeur ne correspond pas à ce qui est attendu par le Datastore (ex: si vous saisissez `trois` au lieu de `3`, ou `une bière` au lieu de `1,5` ...).<br />
</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<br />
== Options ==<br />
<br />
Selon son type, le champ peut aussi être configuré / personnalisé suivant certaines "options". <br />
La colonne '''"Options"''' du tableur est au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'', avec des indentations (4 espaces) pour identifier une série de sous-attributs. <br />
<br />
=== Blockclasses ===<br />
<br />
L'option "blockclasses" permet d'indiquer une liste de classes CSS à appliquer sur le container du champ. <br />
Les classes CSS sont utiles pour paramétrer le style d'un élément HTML. <br />
[[YoProcess]] prédéfini certaines classes CSS afin de permettre les transformations les plus courantes sur les champs du formulaires. <br />
<br />
Notez que les classes sont cumulatives, il suffit de les séparer par un simple espace. <br />
<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|550px|thumb|text-top|Deux champs en colonage grâce aux classes '''"mid-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|550px|thumb|text-top|Trois champs en colonage grâce aux classes '''"third-size nobreak"''']]<br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|550px|thumb|text-top|Aligner le label du champ à droite grâce à '''right-justified-labels''']]<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''blockclasses''' (liste non-exhaustives) :<br />
<br />
::* '''mid-size''' : permet de réduire la taille d'un champ à la moitié de l'espace alloué (lui applique un ratio de 50%) ;<br />
<br />
::* '''third-size''' : permet de réduire la taille d'un champ au tiers de l'espace alloué (lui applique un ratio de 33%) ;<br />
<br />
::* '''nobreak''' : permet d'indiquer que le champ suivant peut venir s'enchainer (colonage) à la suite du champ courant. Cette classe est généralement utilisée de paire avec '''mide-size''' (ou '''third-size''') afin de placer plusieurs champs sur la même ligne. Bien entendu, les champs apparaitront sur la même ligne s'ils en ont la place.<br />
<br />
::* '''left-sided-labels''' : permet de faire en sorte que le label sera placé à gauche du champ (au lieu d'être au dessus, position par défaut). <br />
<br />
::* '''right-justified-labels''' : permet de justifié le libellée du champ à droite au lieu de la justification par défaut à gauche ;<br />
<br />
=== Fieldclasses ===<br />
<br />
Fonctionne de la même façon que l'option "blockclasses" mais les classes précisées ici ne vont s'appliquer que sur l'élément de saisie et non pas sont conteneur. <br />
<br />
Voici une liste de classes qui peuvent être utilisées en tant que '''fieldclasses''' (liste non-exhaustives) :<br />
<br />
::* '''disabled''' : permet de désactiver graphiquement le champ ;<br />
<br />
::* '''text-center''' : permet de centrer tous les textes du champ (libellé, contenu, sous-texte …) ;<br />
<br />
:: ''à compléter'' <br />
<br />
<br />
=== Autonext ===<br />
<br />
L'option "autonext" permet de déclencher automatiquement le bouton "Enregistrer et Continuer" (en bas à droite de chaque slide) dés lors que le dernier champ de choix de la page vient d'être complété. Cette option est surtout utile pour les formulaires dont les slides ne contiennent que des champs "choices-list" ou "choices-block", sans choix multiples. En effet, avec d'autres types de champ, le système ne peut pas détecter que l'utilisateur a "terminé" sa saisie et forcer automatiquement le passage à la page suivante, cela n'est envisageable qu'avec des champs de choix direct. <br />
<br />
Cette option prend pour valeur "Y" ou "N". Ex : <code>autonext: Y</code>.<br />
<br />
<br />
=== Api (injection) ===<br />
<br />
Cette option "api" permet d'intégrer sur le champ en question un "bouton d'appel API". Ce bouton peut déclencher une requête (via des API), à partir de ce qui a été saisie dans le champ, et afin de récupérer des informations complémentaires et de les injecter dans d'autres champs présents sur la page.<br />
<br />
De part son format, cette option n'est accessible que sur les champs de saisie du SmartForm (text-input, number-input, date-input…). <br />
<br />
Cette option est à configurer au format au format [https://geekflare.com/fr/yaml-introduction/ YAML], c'est à dire sous la forme ''"attribut: valeur"'' et avec des indentations (4 espaces) pour identifier les séries de sous-attributs. <br />
<br />
🔗 '''Les détails de cette configuration sont accessible sur la page dédiée : <span style="text-decoration: underline;">[[SmartForm - Injection depuis une API]]</span>.'''<br />
<br />
<br />
=== Default ===<br />
<br />
L'option "default" fonctionne sur les champs de type de saisie (text-input, number-input …). Elle permet de spécifier une valeur à insérer automatiquement dans le champ, au chargement de la page, dés lors que le champ est "vide". La valeur par défaut ne doit pas être confondue avec le "placeholder" (qui sert juste à afficher un texte informatif au sein du champ quand il est vide). Avec cette valeur par défaut, et si elle n'est pas modifiée par l'utilisateur lors de la saisie de la Slide, alors elle sera enregistrée telle-quelle dans le Dataset dés lors que l'utilisateur validera la Slide. À partir du moment où est elle enregistrée, le champ n'est plus "vide" et la valeur affichée est sa valeur réelle et non plus la valeur ''injectée'' par défaut.<br />
<br />
'''Attention''' : un champ avec une valeur par défaut continue d'être vide/incomplet du point de vue de la base de données ([[Dataset]]). Cela peut être trompeur, par exemple, slide qui ne contient que des champs pré-remplis pourra sembler complète alors qu’elle ne l’ai pas du point de vue du Dataset et l'utilisateur peut avoir du mal à comprendre "pourquoi" on lui dit que le formulaire n'est pas complet. De même, le formulaire doit éviter de faire soudainement apparaitre un champ pré-rempli avec une valeur par défaut car si tel est le cas, il peut être difficile pour l’utilisateur de retrouver quel est le champ “vide” (= pourcentage de complétion VS ce que l’on voit sur la slide). Ou encore, notez que les visibleIf au sein de la slide doivent tenir compte du fait que s’ils parlent d’une variable “pré-remplie par défaut” sa valeur est considérée comme “vide” dans les SmartExpression tant qu’elle n’est pas sauvegardée ;<br />
<br />
<br />
=== Mask (masque de saisie) ===<br />
<br />
L'option "mask" fonctionne sur les champs de type de saisie (text-input, date-input …), le format de cette option est définie par [https://imask.js.org/guide.html#masked-pattern la documentation de iMask.js].<br />
<br />
'''Exemple pour un code postal''' : <code>mask: 00 000</code><br />
<br />
'''Quelques formats prédéfinis''' : <br />
<br />
::* <code>mask: dd/mm/yyyy</code> ou <code>mask: date</code>: permet de forcer un format / masque de date (''jj/mm/aaaa'').<br />
<br />
::* <code>mask: hh:mm</code> : permet de forcer un format horaire (''hh:mm'') dans un champ ''text-input''.<br />
<br />
::* <code>mask: number</code> : permet de forcer un format numérique, avec un séparateur de milliers, des virgules, etc. (ce masque est appliqué par défaut sur les champs ''number-input''.</div>Léohttps://wiki.hercule.co/index.php?title=Instructions_de_Boucle_dans_une_Variable_Dynamique_(DynVar_Loop_Statement)&diff=1052Instructions de Boucle dans une Variable Dynamique (DynVar Loop Statement)2021-05-09T22:35:57Z<p>Léo : </p>
<hr />
<div>= Introduction =<br />
<br />
Les [[Dynvars|Variables Dynamiques (DynVar)]] permettent de définir une valeur à partir d'une formule, contrairement aux variables de saisie pour lesquelles une valeur est fixée lors du remplissage d'un formulaire par exemple. <br />
<br />
L'Instruction de Boucle (loop-statement) au sein d'une [[Dynvars|Variable Dynamique]] correspond à une syntaxe spécifique, à placer en première ligne de la formule d'une [[Dynvars|Variable Dynamique]], et qui permet d'indiquer que, pour une variable de liste et une formule ([[SmartExpressions|SmartExpression]]) données, la formule doit être exécutée (calculée) autant de fois que d'éléments présents dans la liste. <br />
<br />
= Syntaxe =<br />
<br />
Il existe deux types d'instruction de boucle : <br />
<br />
* '''"map"''' qui permet de produire une liste à partir d'une liste existante (mapping), où chaque élément de la liste produite est le résultat d'une formule (une [[SmartExpressions|SmartExpression]]) ;<br />
<br />
* '''"reduce"''' qui permet de produire une valeur simple (un nombre, une date, une chaîne de caractère…) à partir d'une liste existante, sur laquelle aura été appliqué une formule (une [[SmartExpressions|SmartExpression]]) sur chacun de ses éléments ;<br />
<br />
L'instruction de boucle est à insérer comme la première ligne d'une formule de [[Dynvars|Variable Dynamique]]. <br />
Voir exemple de paramétrage via un tableau Excel : <br />
<br />
[[Fichier:Excel-loop-statement.png|cadre|center|Exemple du paramétrage d'une DynVar avec une Instruction de Boucle de type #map]]<br />
<br />
[[Fichier:Loop-statement-schema.png|vignette|droite|Schéma explicatif de la syntaxe d'une Instruction de Boucle d'une Variable Dynamique (DynVar Loop Statement)]]<br />
<br />
'''Les instructions de boucle contiennent 3 parties paramétrables :''' <br />
<br />
* Le type de fonction de boucle (#map ou #reduce) <br />
<br />
* Les définitions des variables de boucle : sous la forme <code>LISTE as LIST_ITEM</code>, où LISTE est une variable de liste existante, et LIST_ITEM est un "alias" utilisable seulement dans le corps de cette boucle, et qui aura pour valeur, tour à tour, chaque élément de la liste. <br />
<br />
* La [[SmartExpressions|SmartExpression]] a executer en boucle <br />
<br />
<br />
<br />
<br />
<br />
== Le Mapping == <br />
<br />
<br />
<br />
<br />
Les instructions de boucle de type <code>#map</code> permettent de produire une liste à partir d'une liste existante, où chaque élément de la liste produite est le résultat de la [[SmartExpressions|SmartExpression]] fournie. <br />
<br />
Ce type de boucle est principalement utilisée pour créer des listes de correspondance. Chaque entrée d'une liste étant constitué d'une clé et d'un élément correspondant, le mapping va permettre de créer une nouvelle liste, pour laquelle les clés sont conservées mais les éléments sont remplacés par le résultat de la [[SmartExpressions|SmartExpression]].<br />
<br />
'''Définition de variables de la boucle :''' Dans le cadre d'une boucle <code>#map</code> une seule définition de variable est attendue : la liste à parcourir vers l'élément de l'itération courante (l'alias). <br />
<br />
'''Ex:''' <code>ASSOCIES_LIST as ASSOCIE</code>, <code>CHILDREN_LIST as CHILD_ITEM</code> etc …<br />
<br />
<br />
=== Exemple de Variable Dynamique avec #map ===<br />
<br />
Obtenir une liste <code>PARTNERS_POURCENT_LIST</code>, où pour chaque associé d'une liste ASSOCIES, on va calculer le pourcentage de part qui revient à chacun d'eux, sur un total de 5000 parts : <br />
<br />
<pre><br />
#map list ASSOCIES as ASSOCIE_ITEM<br />
(ASSOCIE_ITEM.ACTIONS / 5000) * 100<br />
</pre><br />
<br />
<br />
=== Exemple d'usage de ce mapping dans un SmartDoc ===<br />
<br />
Maintenant qu'on a généré une liste <code>PARTNERS_POURCENT_LIST</code>, on va pouvoir utiliser ses valeurs "complexes" dans des contextes de boucle. <br />
Par exemple, dans un document, on peut vouloir afficher pour chaque associé son nom et le pourcentage qu'il détient, sachant que ce pourcentage ne se trouve pas initialement dans la liste <code>ASSOCIES</code> (complétée par une Slide répétée du formulaire) mais dans la liste <code>PARTNERS_POURCENT_LIST</code> issue du mapping.<br />
<br />
[[Fichier:Exemple-dynvars-loop-statement-application-smartDoc.png|vignette|centré|Exemple d'application SmartDoc (Variable Dynamique - Instruction de Boucle)]]<br />
<br />
<br />
=== Exemple d'usage de ce mapping dans un SmartForm ===<br />
<br />
Tout comme dans l'exemple précédent, on peut vouloir afficher un champ "Coucou", dans une slide répétée du SmartForm, uniquement si l'associé détient plus de 50% des parts. Le pourcentage détenu par l'associé ne se trouve malheureusement pas dans la liste <code>ASSOCIES</code> mais dans la liste <code>PARTNERS_POURCENT_LIST</code> issue du mapping (car ce sont des pourcentages calculées dynamiquement). <br />
On va donc conditionner le champ avec la SmartExpression <code>get_value(PARTNERS_POURCENT_LIST, ASSOCIES._KEY) > 50.0</code>, qui signifie : ''"Dans la liste PARTNERS_POURCENT_LIST, la valeur correspondante à la clé ''ASSOCIES._KEY'' est elle supérieure à 50 ?".''<br />
<br />
[[Fichier:DynVar-LoopStatement-Map-Example-SmartForm.png|vignette|centré|Exemple d'application sur le SmartForm (Variable Dynamique, Instruction de Boucle #map)]]<br />
<br />
== Reduce ==<br />
<br />
<br />
Les instructions de boucle de type <code>#reduce</code> permettent de produire une valeur simple (un nombre, une date, une chaîne de caractère…) à partir d'une liste existante, sur laquelle aura été appliquée une formule (la [[SmartExpressions|SmartExpression]]) sur chacun de ses éléments ;<br />
<br />
'''Définition de variables de la boucle :''' Dans le cadre d'une boucle <code>#reduce</code>, deux définitions de variable sont attendues : la liste à parcourir vers l'élément de l'itération courante (l'alias), et, la valeur initiale (ex: 0, true…) de la variable spéciale _PREV (qui a pour valeur le résultat de l'itération précédente et dont la dernière valeur sera celle de la Variable Dynamique). <br />
<br />
<br />
=== Exemples de Variables Dynamiques avec #reduce ===<br />
<br />
<br />
<br />
Obtenir une valeur booléenne <code>IS_ANY_ASSOCIEE_NAMED_DAM</code>, qui vaut TRUE, si pour une liste d'ASSOCIES, au moins un des membres s'appelle "Damien" :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, false as _PREV :<br />
_PREV or ASSOCIE_ITEM.PRENOM == "DAMIEN"<br />
</pre><br />
<br />
__<br />
<br />
Obtenir une valeur booléenne <code>IS_ALL_PARTNERS_TEN_POURCENT</code>, valant TRUE, si pour une liste d'ASSOCIES, tous les membres ont plus de 500 parts :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, true as _PREV :<br />
_PREV and ASSOCIE_ITEM.ACTIONS > 500.0<br />
</pre><br />
<br />
__<br />
<br />
Renvoie une variable numérique <code>COUNT_PARTNERS_WITH_500_OR_MORE</code> donnant le nombre des associés qui ont au moins 500 parts :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, 0 as _PREV :<br />
_PREV + (ASSOCIE_ITEM.ACTIONS > 500.0 ? 1 : 0)<br />
</pre><br />
<br />
__<br />
<br />
Renvoie une variable numérique <code>AVERAGE_PARTNERS_YEARS_OLD</code>, correspondant à la moyenne d'âge de tous les associés :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, 0 as _PREV :<br />
_PREV + (ASSOCIE_ITEM.AGE / ASSOCIES._COUNT)<br />
</pre><br />
<br />
(coming soon)</div>Léohttps://wiki.hercule.co/index.php?title=Instructions_de_Boucle_dans_une_Variable_Dynamique_(DynVar_Loop_Statement)&diff=1051Instructions de Boucle dans une Variable Dynamique (DynVar Loop Statement)2021-05-08T17:06:24Z<p>Léo : </p>
<hr />
<div>= Introduction =<br />
<br />
Les [[Dynvars|Variables Dynamiques (DynVar)]] permettent de définir une valeur à partir d'une formule, contrairement aux variables de saisie pour lesquelles une valeur est fixée lors du remplissage d'un formulaire par exemple. <br />
<br />
L'Instruction de Boucle (loop-statement) au sein d'une [[Dynvars|Variable Dynamique]] correspond à une syntaxe spécifique, à placer en première ligne de la formule d'une [[Dynvars|Variable Dynamique]], et qui permet d'indiquer que, pour une variable de liste et une formule ([[SmartExpressions|SmartExpression]]) données, la formule doit être exécutée (calculée) autant de fois que d'éléments présents dans la liste. <br />
<br />
= Syntaxe =<br />
<br />
Il existe deux types d'instruction de boucle : <br />
<br />
* '''"map"''' qui permet de produire une liste à partir d'une liste existante (mapping), où chaque élément de la liste produite est le résultat d'une formule (une [[SmartExpressions|SmartExpression]]) ;<br />
<br />
* '''"reduce"''' qui permet de produire une valeur simple (un nombre, une date, une chaîne de caractère…) à partir d'une liste existante, sur laquelle aura été appliqué une formule (une [[SmartExpressions|SmartExpression]]) sur chacun de ses éléments ;<br />
<br />
L'instruction de boucle est à insérer comme la première ligne d'une formule de [[Dynvars|Variable Dynamique]]. <br />
Voir exemple de paramétrage via un tableau Excel : <br />
<br />
[[Fichier:Excel-loop-statement.png|cadre|center|Exemple du paramétrage d'une DynVar avec une Instruction de Boucle de type #map]]<br />
<br />
[[Fichier:Loop-statement-schema.png|vignette|droite|Schéma explicatif de la syntaxe d'une Instruction de Boucle d'une Variable Dynamique (DynVar Loop Statement)]]<br />
<br />
'''Les instructions de boucle contiennent 3 parties paramétrables :''' <br />
<br />
* Le type de fonction de boucle (#map ou #reduce) <br />
<br />
* Les définitions des variables de boucle : sous la forme <code>LISTE as LIST_ITEM</code>, où LISTE est une variable de liste existante, et LIST_ITEM est un "alias" utilisable seulement dans le corps de cette boucle, et qui aura pour valeur, tour à tour, chaque élément de la liste. <br />
<br />
* La [[SmartExpressions|SmartExpression]] a executer en boucle <br />
<br />
<br />
<br />
<br />
<br />
== Le Mapping == <br />
<br />
<br />
<br />
<br />
Les instructions de boucle de type <code>#map</code> permettent de produire une liste à partir d'une liste existante, où chaque élément de la liste produite est le résultat de la [[SmartExpressions|SmartExpression]] fournie. <br />
<br />
Ce type de boucle est principalement utilisée pour créer des listes de correspondance. Chaque entrée d'une liste étant constitué d'une clé et d'un élément correspondant, le mapping va permettre de créer une nouvelle liste, pour laquelle les clés sont conservées mais les éléments sont remplacés par le résultat de la [[SmartExpressions|SmartExpression]].<br />
<br />
'''Définition de variables de la boucle :''' Dans le cadre d'une boucle <code>#map</code> une seule définition de variable est attendue : la liste à parcourir vers l'élément de l'itération courante (l'alias). <br />
<br />
'''Ex:''' <code>ASSOCIES_LIST as ASSOCIE</code>, <code>CHILDREN_LIST as CHILD_ITEM</code> etc …<br />
<br />
<br />
=== Exemple de Variable Dynamique avec #map ===<br />
<br />
Obtenir une liste <code>PARTNERS_POURCENT_LIST</code>, où pour chaque associé d'une liste ASSOCIES, on va calculer le pourcentage de part qui revient à chacun d'eux, sur un total de 5000 parts : <br />
<br />
<pre><br />
#map list ASSOCIES as ASSOCIE_ITEM<br />
(ASSOCIE_ITEM.ACTIONS / 5000) * 100<br />
</pre><br />
<br />
<br />
=== Exemple d'usage de ce mapping dans un SmartDoc ===<br />
<br />
Maintenant qu'on a généré une liste <code>PARTNERS_POURCENT_LIST</code>, on va pouvoir utiliser ses valeurs "complexes" dans des contextes de boucle. <br />
Par exemple, dans un document, on peut vouloir afficher pour chaque associé son nom et le pourcentage qu'il détient, sachant que ce pourcentage ne se trouve pas initialement dans la liste <code>ASSOCIES</code> (complétée par une Slide répétée du formulaire) mais dans la liste <code>PARTNERS_POURCENT_LIST</code> issue du mapping.<br />
<br />
[[Fichier:Exemple-dynvars-loop-statement-application-smartDoc.png|vignette|centré|Exemple d'application SmartDoc (Variable Dynamique - Instruction de Boucle)]]<br />
<br />
<br />
=== Exemple d'usage de ce mapping dans un SmartForm ===<br />
<br />
Tout comme dans l'exemple précédent, on peut vouloir afficher un champ "Coucou", dans une slide répétée du SmartForm, uniquement si l'associé détient plus de 50% des parts. Le pourcentage détenu par l'associé ne se trouve malheureusement pas dans la liste <code>ASSOCIES</code> mais dans la liste <code>PARTNERS_POURCENT_LIST</code> issue du mapping (car ce sont des pourcentages calculées dynamiquement). <br />
On va donc conditionner le champ avec la SmartExpression <code>get_value(PARTNERS_POURCENT_LIST, ASSOCIES._KEY) > 50.0</code>, qui signifie : ''"Dans la liste PARTNERS_POURCENT_LIST, la valeur correspondante à la clé ''ASSOCIES._KEY'' est elle supérieure à 50 ?".''<br />
<br />
[[Fichier:DynVar-LoopStatement-Map-Example-SmartForm.png|vignette|centré|Exemple d'application sur le SmartForm (Variable Dynamique, Instruction de Boucle #map)]]<br />
<br />
== Reduce ==<br />
<br />
<br />
Les instructions de boucle de type <code>#reduce</code> permettent de produire une valeur simple (un nombre, une date, une chaîne de caractère…) à partir d'une liste existante, sur laquelle aura été appliquée une formule (la [[SmartExpressions|SmartExpression]]) sur chacun de ses éléments ;<br />
<br />
'''Définition de variables de la boucle :''' Dans le cadre d'une boucle <code>#reduce</code>, deux définitions de variable sont attendues : la liste à parcourir vers l'élément de l'itération courante (l'alias), et, la valeur initiale (ex: 0, true…) de la variable spéciale _PREV (qui a pour valeur le résultat de l'itération précédente et dont la dernière valeur sera celle de la Variable Dynamique. <br />
<br />
<br />
=== Exemples de Variables Dynamiques avec #reduce ===<br />
<br />
<br />
<br />
Obtenir une valeur booléenne <code>IS_ANY_ASSOCIEE_NAMED_DAM</code>, qui vaut TRUE, si pour une liste d'ASSOCIES, au moins un des membres s'appelle "Damien" :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, false as _PREV :<br />
_PREV or ASSOCIE_ITEM.PRENOM == "DAMIEN"<br />
</pre><br />
<br />
__<br />
<br />
Obtenir une valeur booléenne <code>IS_ALL_PARTNERS_TEN_POURCENT</code>, valant TRUE, si pour une liste d'ASSOCIES, tous les membres ont plus de 500 parts :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, true as _PREV :<br />
_PREV and ASSOCIE_ITEM.ACTIONS > 500.0<br />
</pre><br />
<br />
__<br />
<br />
Renvoie une variable numérique <code>COUNT_PARTNERS_WITH_500_OR_MORE</code> donnant le nombre des associés qui ont au moins 500 parts :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, 0 as _PREV :<br />
_PREV + (ASSOCIE_ITEM.ACTIONS > 500.0 ? 1 : 0)<br />
</pre><br />
<br />
__<br />
<br />
Renvoie une variable numérique <code>AVERAGE_PARTNERS_YEARS_OLD</code>, correspondant à la moyenne d'âge de tous les associés :<br />
<br />
<pre><br />
#reduce list ASSOCIES as ASSOCIE_ITEM, 0 as _PREV :<br />
_PREV + (ASSOCIE_ITEM.AGE / ASSOCIES._COUNT)<br />
</pre><br />
<br />
(coming soon)</div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=998SmartDoc2020-12-08T14:33:00Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
<h3 id="Métadonnées">Métadonnées</h3><br />
<p> C'est un simple espace de commentaire </p><br />
<h3 id="Datastore">DataStore</h3><br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<h3 id="title-num-display">Options - title-num-display</h3><br />
<p>title-num-display : cette colonne permet de définir le format d’affichage pour la numérotation de chaque titre du document. Cette option attend un tableau, où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, deux attributs à configurer : style et format .</p><br />
<p><strong>Les valeurs possible pour les attributs style sont :</strong><br />
<p>&quot;upper-roman&quot; : nombre romain majuscule (I, II, III, IV etc...)</p> <br />
<p>&quot;decimal&quot; : numérotation décimale / chiffres arabes (1, 2 , 3 ...)</p><br />
<p>&quot;lower-roman&quot; : nombre romain minuscule (i, ii, iii, iv etc.)</p><br />
<p>&quot;lower-alpha” : numérotation alphabétique minuscule (a, b, c, d...)</p><br />
<p>&quot;upper-alpha&quot; : numérotation alphabétique majuscule (A, B, C, D, E)</p><br />
<p><strong>En ce qui concerne l’attributs format :</strong><br />
Il attend une chaîne de caractère dans laquelle $1, $2, $3 … $6 seront remplacés par la numérotation (au style attribué). <br />
Exemple : “Article $1.$2” peut donner “Article 3.a”.</p><br />
<p><strong>Exemple complet :</strong></p><br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
<p>Où les titres :</p><br />
<p>de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”</p><br />
<p>de niveau 2 seront de la forme : “2 Lorem ipsum ”</p><br />
<p>de niveau 3 seront de la forme : “2-5 Lorem ipsum ”</p><br />
<p>de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”</p><br />
<p>de niveau 5 seront de la forme : “a. Lorem ipsum ”</p><br />
<p>de niveau 6 seront de la forme : “ iv ) Lorem ipsum”</p><br />
<h3 id="List-Labels">List-Labels</h3><br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
<h2 id="contenu-options-styles-visible-if-commentaires">Contenu, options, styles, [[Conditions|visible ifs]], commentaires</h2><br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivants sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span<br />
</p><br />
<h4 id="spec">Fonctionnalités spéciales dans la colonne "contenu"</h4><br />
<p><code>{@line-break}</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> </p><br />
<p><code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.</p><br />
<p>Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.</p><br />
<p><code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:uppercase}</code>,</p><br />
<p><code>:num</code>Le traitement “:num” peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:num}</code>, vous...<br />
devient : Comme décrit dans la section <b>3.1.1.2</b>, vous …</p><br />
<p>Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<p><code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code></p><br />
<h4 id="le-contenu-variable-a-name-variables-a-">Comment insérer des variables dans un [[SmartDoc]] ?</h4><br />
<p>La syntaxe dynamique à l’intérieur du contenu des SmartDoc est dans un format propre à Hercule, et se distingue du reste du texte car elle est entre <code>{</code> et <code>}</code>.</p><br />
<p>Il est possible d’utiliser les variables de deux manières : en “primitive” (c'est-à-dire : sans aucun traitement) ou en appliquant une modification qu’on appelle un "traitement".</p><br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<h5 id="les-traitements">Les traitements</h5><br />
<p>Les traitements peuvent être définies comme une modification appliquée sur une primitive. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong><br />
L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<h6 id="liste-des-traitements-int-gr-s">Liste des traitements intégrés</h6><br />
<p>Pour l’instant, les traitements intégrés sont : </p><br />
<br/><br />
<p><code>:uppercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en majuscule</p><br />
<br/><br />
<p><code>:lowercase</code> : ne s'applique que sur une chaine de caractères, et permet de forcer l’affichage de la chaîne en minuscule</p><br />
<br/><br />
<p><code>:letters</code> : ne s'applique que sur une valeur numérique, et permet de la convertir en "toutes-lettres" (ex : <code>312</code> => <code>Trois-cent-douze</code>).</p><br />
<br/><br />
<p><code>:capitalize</code> : ne s'applique que sur une chaine de caractères, et permet de passer en majuscule la première lettre de chaque mot.</p><br />
<br/><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document. Ex : <code>{"https://pbs.twimg.com/profile_images/1078604064437518336/xYwlu68e_400x400.jpg":img}</code> va permettre d'intégrer l'image présente à cette URL dans le document.</p><br />
<br/><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<br/><br />
<p><code>:french-datetime</code> : ne s'applique que sur une date ou une chaîne de caractère au format "Date". Ce traitement permet de transformer la date au format "30/12/1985 à 12h45".</p><br />
<br/><br />
<p><code>:french-date</code> : ne s'applique que sur une date ou une chaîne de caractère au format "YYYY-MM-DD" (format international). Ce traitement permet de transformer la date fournie dans le format Français "jj/mm/aaaa". Depuis la version v0.10, ce filtre est "facultatif" car il est appliqué par défaut sur les dates ou les chaînes au format de date. </p><br />
<br/><br />
<p><code>:num-format</code> : ne s'applique que sur une valeur numérique, et permet de la formater pour son affichage. Ce traitement peut prendre 3 paramètres '''facultatifs'''. <br/><br />
<ul><br />
<li>Le 1er permet (numérique et facultatif) permet d'indiquer le nombre de décimale souhaitées (par défaut, 2 chiffres ou 0 si la partie décimale est nulle).</li><br />
<li>Le second paramètre (chaîne, facultative) correspond au séparateur des milliers (par défaut : un espace).</li><br />
<li>Le troisième paramètre (chaîne, facultative) correspond au caractère à afficher pour le séparateur décimal (par défaut : <code>,</code>).</li><br />
</ul><br />
Quelques exemples : <ul><br />
<li> - soit une variable numérique VAR_PI qui vaut <code>3,1451</code>. L'affichage par défaut <code>{ VAR_PI }</code> affichera <code>3,14</code>. <br/> L'affichage <code>{ VAR_PI:num-format(3) }</code> affichera <code>3,145</code>. </li><br />
<li> - pour la variable PRICE (numérique) qui vaudrait <code>9 999,99</code>, l'affichage <code>{ PRICE:num-format }</code> affichera <code>9 999,99</code> (dans ce cas le `:num-format` est facultatif). <br/>Par contre, l'affichage <code>{ PRICE:num-format(1,',', '.') }</code> affichera <code>9,999.9</code> (1 chiffre après la virgule, séparateur des milliers et décimaux modifiés).</li><br />
</ul><br />
</p><br />
<br/><br />
<br />
<p><code>:join</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code></p><br />
<br/><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<br/><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<br/><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<h3 id="styles">Styles</h3><br />
<p>La colonne Styles est facultative, et permet de traiter différemment le contenu de la ligne concernée. </p><br />
<p>A chaque traitement utilisé, on retournera à la ligne après avoir écrit un <code>;</code></p><br />
*Définir la police :<br />
<p>Le traitement “<code>font-family</code>” permet de spécifier la police utilisée. </p><br />
<p>Ce traitement peut prévoir plusieurs polices, comme un système à plusieurs détentes : si le navigateur utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...</p><br />
<p>Exemple : </p><br />
<p> <code>font-family: Times New Roman, Times, serif;</code><br />
<p>Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité.</p><br />
<p>Si le navigateur ne supporte pas cette police, on cherchera à afficher une police de la famille “Times”.</p><br />
<p>Enfin, si rien de tout cela ne marche, on cherchera à afficher une police de type “Serif”</p><br />
*Définir la taille de la police : </p><br />
<p><code>font-size: XXpt;</code><br />
<p>On remplacera XX par la taille de police souhaitée</p><br />
*Mettre en gras :<br />
<code>font-weight: bold</code></p><br />
*Mettre en italique : <br />
<code>font-style: italic;</code></p><br />
*Souligner le texte : <br />
<code>text-decoration: underline;</code></p><br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
*Aligner le texte</p><br />
<p><code>text-align: right</code><br />
<code>text-align: left</code><br />
<code>text-align: center</code><br />
<code>text-align: justify</p></code></p><br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<h3 id="visible-if">[[Conditions|Visible if]]</h3><br />
<p>Ici, les [[Conditions|visible ifs]] permettront de conditionner logiquement l’apparition du texte se trouvant dans la colonne “Contenu”<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]]</p><br />
<h3 id="utiliser-les-loops-boucles-">Utiliser les [[Boucles]]</h3><br />
<p>Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]]</p><br />
<h3 id="commentaire">Commentaire</h3><br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=994SmartExpressions2020-11-23T14:28:35Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<p>La méthode utilisée est celle de l'arrondi [https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique arithmétique].</p><br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=993SmartExpressions2020-11-23T14:28:18Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi [https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique arithmétique].<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=992SmartExpressions2020-11-23T14:27:54Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi [https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique MediaWiki].<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=991SmartExpressions2020-11-23T14:24:56Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi [[arithmétique|https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique]].<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=990SmartExpressions2020-11-23T14:24:24Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi [[https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique|arithmétique]].<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=989SmartExpressions2020-11-23T14:23:41Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi <a href="https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique" target="_blank" rel="nofollow">arithmétique</a><br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=988SmartExpressions2020-11-23T14:23:10Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
La méthode utilisée est celle de l'arrondi <a href="https://fr.wikipedia.org/wiki/Arrondi_(math%C3%A9matiques)#Arrondi_au_plus_proche_ou_arrondi_arithm%C3%A9tique" target="_blank" rel="nofollow">arithmétique</a>.<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=Variables_dynamiques_(DynVars)&diff=987Variables dynamiques (DynVars)2020-11-23T14:21:25Z<p>Léo : </p>
<hr />
<div><p>''Cette page est encore en cours de rédaction''</p><br />
<p>''Vous y trouverez néanmoins les informations essentielles concernant les Dynvars. En cas de problème, contactez votre chef de projet''</p><br />
<br />
<h1>Introduction</h1><br />
<br />
Une "Dynvar" est une variable particulière, qui est définie par une '''formule''' au lieu d'avoir pour vocation de stocker directement une information.<br />
<br />
<h1>Mise en place</h1><br />
<br />
<h2>Création d'une feuille Dynvars</h2><br />
Le fichier de paramétrage doit contenir une feuille nommée <code>Dynvars "mainstore"</code><br />
[[Fichier:Capture d’écran 2019-08-22 à 11.27.17.png|thumb|néant|250px|Dynvars mainstore]]<br />
<br />
Cette feuille doit contenir trois colonnes : <br />
[[Fichier:Capture d’écran 2019-08-22 à 11.28.32.png|900px|thumb|néant]]<br />
<br />
<h3>ID</h3><br />
<p>'''ID : c'est le nom de la Dynvar'''</p><br />
<p>- Les Dynvars doivent respecter les mêmes règles syntaxiques que les [[DataStore#Id_de_la_variable|Variables]], à savoir : </p><br />
<p>- Le nom de la variable doit être en majuscules </p><br />
<p>- Les espaces ne sont pas autorisés. Pour marquer un espace, on préférera donc les tirets du bas qui eux sont autorisés : _</p><br />
<p>Les accents & et caractères spéciaux ne sont pas non plus autorisés.</p><br />
</p><br />
<h3>Formule</h3><br />
<p>'''Formule : c'est la formule utilisée pour donner une valeur à cette Dynvar'''</p><br />
<h3>ID de la source</h3><br />
<p>'''ID de la source :''' pour l'instant, une seule valeur est possible (et '''obligatoire''') ici : <code>dynvar</code></p><br />
<h1>Cas d'usages</h1><br />
<p>'''Introduction :''' Les Dynvars reposent sur une syntaxe spécifique nommée [[SmartExpressions]] : vous trouverez des informations plus détaillée sur la [[SmartExpressions|page dédiée]].</p><br />
<p>Cette page présente uniquement les [[SmartExpressions]] basiques les plus utilisées dans les Dynvars.</p><br />
<p>Pour plus d'informations et de précisions sur la syntaxe, rendez-vous sur la [[SmartExpressions|page dédiée]].</p><br />
<h2>Opérations mathématiques</h2><br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<h2>Factorisation du raisonnement</h2><br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<h2>Utilisation des Dynvars pour stocker des chaînes de caractères</h2><br />
''Coming Soon''</div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=986SmartExpressions2020-11-17T09:53:08Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates) <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "day")</code> => renvoie <code>5732</code> (le nombre total de jour entre les deux dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=Form-List&diff=975Form-List2020-10-30T18:24:05Z<p>Léo : </p>
<hr />
<div><h1 id="form-list">Form-List</h1><br />
<p><strong>Créer une feuille Form-List sera nécessaire dès qu&#39;une configuration nécessitera plusieurs formulaires</strong></p><br />
<h2 id="cr-er-une-form-list">Créer une Form-List</h2><br />
<p>La feuille doit impérativement se nommer &quot;Form-List&quot; pour que le système puisse la reconnaître.</p><br />
<p>Elle contient les colonnes suivantes : form-id, title, description, [[Conditions|visible if]], et [[DataStore|datastore]].<br />
[[Fichier:Form-List.png|frame|none|Mise au point d'une Form-List]]<br />
</p><br />
<p>Chaque ligne est égale à un nouveau formulaire</p><br />
<ul><br />
<li>form-id : La colonne form-id contient l&#39;identifiant du formulaire, identifiant qui devra être impérativement repris pour créer les feuilles &quot;Sections-Form&quot; et &quot;Fields-Form&quot;</li><br />
<li>title : C&#39;est le titre du formulaire, visible par l&#39;utilisateur final</li><br />
<li>description : C&#39;est une description brève du formulaire, visible par l&#39;utilisateur final</li><br />
<li>Visible if : Permet de définir les [[Conditions]] d&#39;apparition du formulaire, le fonctionnement est similaire au reste du système.</li><br />
<li>Datastore : Il faut entrer ici l&#39;id du [[DataStore]] qui sera alimenté grâce au réponses entrées dans le formulaire. Dans le doute, entrer &quot;mainstore&quot;.</li><br />
</ul></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=974SmartExpressions2020-10-22T14:29:52Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
=== Fonctions sur les Dates ===<br />
<br />
===== Opération sur une date =====<br />
<br />
Cette fonction permet de réaliser des opérations (somme et soustraction) sur une date. C'est à dire que pour une date donnée, la fonction permet d'obtenir une date antérieur ou postérieure de N jours / années / heures (etc.). Cette fonction est utile pour calculer une date d'échéance (ex : ''"3 mois après la date de signature…"''), ou parler d'une date en fonction d'une autre (Ex : ''"12 jours avant la date…"'').<br />
<br />
# Nom de la fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
<ul style="margin-left:50px"><br />
<li> 1 - Date à traiter (variable provenant d'un DateInput, ou chaîne format "d-m-Y H:i")</li><br />
<li> 2 - Un nombre entier (positif ou négatif) </li><br />
<li> 3 - L'unité sous forme d'une chaîne de caractères parmi : "year"; "month"; "day"; "hour"; "minute"; "second"</li><br />
</ul><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<div>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut rajouter 3 jours à cette date : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, 3, "day")</code> => renvoie <code>15/05/2020</code> </p><br />
</div><br />
<div><br />
Ou avec une valeur négative, pour soustraire 3 ans par exemple : <br />
<p> ▷ <code>date_sum(DATE_SIGNATURE, -3, "year")</code> => renvoie <code>12/05/2017</code> </p><br />
</div><br />
</div><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''12/05/2020'', et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p> ▷ <code>date_before(DATE_SIGNATURE,"01-01-2020")</code> => renvoie <code>FAUX</code> <br/> <br />
▷ Alors que <code>date_before(DATE_SIGNATURE,"01-01-2021")</code> => renvoie <code>VRAI</code> <br />
</p><br />
</div><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
Renvoie un nombre (valeur absolue) correspondant à la différence, entre la Date de début et la Date de fin, dans l'unité spécifiée. <br />
<div style="margin-left: 30px"> <br />
<p><b style="color: #777;">Par exemple :</b></p><br />
<p>Soit une date de signature (''DATE_SIGNATURE'') ayant pour valeur le ''31/05/2020'', et l'on veut savoir combien d'années de différence entre les 2 dates :<br />
<p> ▷ <code>date_diff(DATE_SIGNATURE,"20-09-2004","year")</code> => renvoie <code>15</code> car 15 années se sont écoulées <br/><br />
▷ <code>date_diff("20-09-2004",DATE_SIGNATURE, "year")</code> => renvoie aussi <code>15</code> (la valeur est absolue, peu importe l'ordre des dates)<br />
</p><br />
</div><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=956SmartExpressions2020-10-19T15:53:02Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
=== Applications ===<br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== addition de deux dates =====<br />
<br />
# Fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Un nombre, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Ajouter 3 années à une date de signature </p><br />
<p><code>date_sum(DATE_SIGNATURE,3,year)</code></p><br />
<p>La Dynvar ainsi paramétrée renverra la date d'arrivée en ajoutant 3 années à la date de signature</p><br />
<br />
===== savoir si une date est avant une autre date =====<br />
<br />
# Fonction : <code>date_before</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : <code>Date 1</code>, <code>Date 2</code><br />
<br />
<p>Renvoie VRAI si la Date 1 est antérieure à la Date 2. Renvoie FAUX sinon. </p><br />
<p>Notez que la Date 1 ou la Date 2 peuvent provenir d'une variable complétée par la valeur d'un champ "date-input" d'un SmartForm, ou correspondre à une date fixe fournie sous la forme d'une chaîne de caractère au format <code>j-m-A</code> (la précision peut aller jusqu'à la seconde : <code>j-m-A h:m:s</code>)</p><br />
<br />
<p>Par exemple :</p><br />
<p>Soit une date de signature (DATE_SIGNATURE) ayant pour valeur le 12/05/2020, et l'on veut vérifier que la signature soit antérieure à la date du 1er Janvier 2020 :<br />
<p><code>date_before(DATE_SIGNATURE,"01/01/2020")</code> => renvoie <code>FAUX</code> </p><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/12/2004 (à fournir sous la forme d'une chaîne de caractère <code>j-m-A</code>)</p><br />
<p><code>date_diff(DATE_SIGNATURE,"09-12-2004","year")</code> </p><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=951Fields-Form2020-10-15T13:20:06Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="mid-size-break">Mid-size break</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size break</code>, qui permet de diviser par deux la taille prise par un champ tout en revenant à la ligne pour le champ d'après..</p><br />
<p> Par contre, grâce à l'instruction <code>break</code>, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size break</code> ne se retrouveront pas collés l'un à l'autre</p><br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h4 id="third-size-break">Third-size break</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size break</code>, qui permet de diviser par trois la taille prise par un champ tout en revenant à la ligne pour le champ d'après.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size break</code> ne se retrouveront pas collés l'un à l'autre</p><br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=950Fields-Form2020-10-15T13:19:38Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="mid-size-break">Mid-size break</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size break</code>, qui permet de diviser par deux la taille prise par un champ tout en revenant à la ligne pour le champ d'après..</p><br />
<p> Par contre, grâce à l'instruction <code>break</code>, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size break</code> ne se retrouveront pas collés l'un à l'autre</p><br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h4 id="third-size-break">Third-size break</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size break</code>, qui permet de diviser par trois la taille prise par un champ tout en revenant à la ligne pour le champ d'après.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size break</code> ne se retrouveront pas collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=949Fields-Form2020-10-09T12:02:06Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none dans le paramétrage : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=948Fields-Form2020-10-09T10:44:32Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750px|Le choix !none en pratique : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=947Fields-Form2020-10-09T10:44:17Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|thumb|none|750|Le choix !none en pratique : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=946Fields-Form2020-10-09T10:44:04Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|frame|none|750|Le choix !none en pratique : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=945Fields-Form2020-10-09T10:43:37Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Fields-Form#Multiple-choices|multiple-choices]]</p><br />
<p> Si l'utilisateur coche le choix associé à <code>!none</code>, tous les autres choix de la liste se décocheront automatiquement</p><br />
[[Fichier:Le !none.png|frame|none|Le choix !none en pratique : il s'insère comme un choix classique, mais son identifiant spécifique !none permet au système de lui donner une fonction spéciale]]<br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fichier:Le_!none.png&diff=944Fichier:Le !none.png2020-10-09T10:42:31Z<p>Léo : </p>
<hr />
<div>le !none</div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=943Fields-Form2020-10-09T10:26:06Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h3 id="choices-specifiques">Choix spécifiques</h3><br />
<h4 id="none">Le choix !none</h3><br />
<p> <code>!none</code> est un choix spécifique qui peut être prévu dans la colonne Choices lorsque la variable est [[Multiple-Choices]]</p><br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
<p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=942Fields-Form2020-10-09T09:54:26Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|1100px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
<p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=941Fields-Form2020-10-09T09:54:06Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
[[Fichier:Choices - exemple.png|500px|thumb|néant|Exemple de configuration d'un champ choices]]<br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
<p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=Fichier:Choices_-_exemple.png&diff=940Fichier:Choices - exemple.png2020-10-09T09:53:46Z<p>Léo : </p>
<hr />
<div>choices : exemple</div>Léohttps://wiki.hercule.co/index.php?title=SmartDocX&diff=939SmartDocX2020-10-08T08:02:24Z<p>Léo : </p>
<hr />
<div><h1 id="smartdocx">SmartDocX</h1><br />
<h2 id="introduction">Introduction</h2><br />
<p>Le SmartDocX est proche d&#39;une méthode de publipostage.</p><br />
<p>On parle aussi de &quot;publipostage intelligent&quot;.</p><br />
<p>Utiliser la méthode SmartDocX pour produire des output est très pratique pour des documents comportant peu de conditions, et donc quasi-uniquement des variables.</p><br />
<h2 id="d-finition">Définition</h2><br />
<p>Un SmartDocX est un document Word &quot;classique&quot; mais prévu pour accueillir des variables définies dans un [[DataStore]].</p><br />
<h2 id="utilisation-du-smartdocx">Utilisation du SmartDocX</h2><br />
<h3 id="int-grer-des-variables">Intégrer des variables</h3><br />
<p>Pour <strong>intégrer des variables dans un document Word</strong>, il est nécessaire de les déclarer de la manière suivante : <code>${MAVARIABLE}</code>.<br />
Par exemple : <br />
[[Fichier:Smartdocx exemple.png|frame|none|Exemple d'un SmartDocX : les variables sont bien déclarées grâce à la syntaxe ${VARIABLE}]]<br />
Le DataStore prêt à recevoir ces variables ressemble à ceci : <br />
[[Fichier:DataStore prêt pour un smartdocx.png|frame|none|Un DataStore préparé pour le SmartDocX "Déclaration de non-condamnation et de filiation"]]<br />
</p><br />
<p>Chaque variable déclarée dans le SmartDocX doit trouver sa contrepartie dans le [[DataStore]].</p><br />
<p>Généralement, il faudra aussi questionner chacune des variables placées dans le SmartDocX en créant le [[Fields-Form |formulaire]] approprié.</p><br />
<br />
=== Paramétrer l'appel du SmartDocX ===<br />
<br />
Pour mettre au point l'appel du SmartDocX, il faut non seulement prévoir cela dans le fichier de paramétrage, mais aussi dans l'interface [[Sandbox]]<br />
<br />
==== Dans le fichier de configuration ====<br />
<br />
Il est avant tout nécessaire de préparer le fichier de configuration à la génération d'un SmartDocX.<br />
<br />
Cela se passe dans la [[DocList]]<br />
<br />
[[Fichier:DocList smartdok.png|frame|none|Une DocList prévue pour générer deux documents basés sur la méthode SmartDocX]]<br />
<br />
Cette étape est très classique, il suffit simplement de prévoir un id, un titre, une description, comme pour tous les docs, mais de rajouter la mention "smartdocx" dans la colonne ''type''.<br />
<br />
==== Dans YOLab ====<br />
<br />
Une fois la [[DocList]] correctement paramétrée et la configuration téléversée, YoLab détecte que un ou plusieurs documents sont des SmartDocX et demande à ce qu'ils soient uploadés.<br />
<br />
[[Fichier:SmartDocxupload.png|frame|none|Mise en place d'un SmartDocX]]<br />
<br />
Il suffit de cliquer sur "Ajouter un fichier" (ou "Remplacer" si un SmartDocX est déjà uploadé) et de sélectionner le SmartDocX.<br />
<br />
<h3 id="int-grer-des-champs-conditionnels">Intégrer des champs conditionnels</h3><br />
<p>''Coming soon''</p></div>Léohttps://wiki.hercule.co/index.php?title=Smartdoc/titre-et-references&diff=938Smartdoc/titre-et-references2020-10-06T12:54:30Z<p>Léo : </p>
<hr />
<div>= Titres, numérotation et références =<br />
<br />
<br/><br />
<br />
'''Contexte :''' <br />
<br />
Le [[SmartDoc|SmartDoc]] correspond à un système de document dynamique qu'il est possible de paramétrer avec des variables (pour intégrer des valeurs de façon dynamique), des [[Conditions|conditions de visibilités]] (afficher ou masquer un élément du document selon telle ou telle condition), et même des [[Boucles|conditions de répétitions]] (répéter un éléments autant de fois que nécéssaire). <br />
<br />
Mais qu'en est il des titres, sous-titres et de leur numérotation ? Comment paramétrer cela dans un modèle de document dynamique puisque n'importe quel chapitre peut apparaitre et disparaitre selon le contexte et que cela remet en cause la numérotation ? Comment faire référence à titre alors que sa numérotation est dynamique ? <br />
C'est tout cela que nous vous expliquons ici. <br />
<br />
<br />
== Définir un titre ==<br />
<br />
Comme défini dans la [[SmartDoc|rubrique dédiée]], un [[SmartDoc|SmartDoc]] est constitué d'une suite ordonnée ''[[Élément_de_contenu|d'éléments de contenu]]''. <br />
Dans la feuille du tableur de paramétrage, il faut créer autant de lignes que d'[[Élément_de_contenu|éléments de contenus dynamiques]]. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge). <br />
<br />
Les [[SmartDoc#Options|"options"]] disponibles sur l'élément de contenu permettent de définir des caractéristiques spéciales de cet élément : notamment indiquer que cet élément doit être considéré comme un titre, lui assigner un "niveau" (titre de niveau 1, 2, ...) et un "identifiant" pour s'y référer.<br />
<br />
:: '''Marche à suivre :''' <br />
:: - Créer un nouvel ''[[Élément_de_contenu|élément de contenu]]'' (c'est à dire une nouvelle ligne dans la feuille du tableur de paramétrage)<br />
:: - Saisissez le titre à affiche dans la colonne "Contenu"<br />
:: - Donner à ce nouvel élément l'option "title-level" pour qu'il soit considéré comme un titre / sous-titre interne au document. L'option "title-level" doit définir le niveau du titre (de 1 à 6 inclus). Ex: `title-level: 3` <br />
:: - Vous pouvez éventuellement rajouter une condition de visibilité sur votre élément (comme pour tout autre élément). Notez néanmoins que seul le titre sera affecté par cette condition, pas le contenu qui suit (pour conditionner la visibilité d'une rubrique entière, utilisez [[SmartDoc/Blocs|le système de blocs]]).<br />
<br />
<br />
Notez que :<br />
* Ce système de niveau de titre permet de réguler la hiérarchie des titres du document, mais '''ce n'est en rien un moyen de styliser un titre pour qu'il apparaissent plus grand ou plus petit''' (utilisez les "styles" pour cela) ;<br />
* Il est préférable de '''respecter la logique hiérarchique''' : un titre de niveau 2 ne peut être défini qu'au sein d'un titre de niveau 1, et qu'un titre de niveau 3 ne le sera qu'au sein d'un titre de niveau 2 et ainsi de suite. Il ne serait pas logique de définir un titre de niveau 5 directement en dessous d'un titre de niveau 1 (il sera alors considéré par le document comme un titre de niveau 2 même si vous avez indiqué 5) ;<br />
* Si vous rajoutez une [[SmartDoc#Visible_if|conditions de visibilités]] sur un titre, cela ne fera pas disparaitre le contenu de la rubrique mais seulement le titre lui-même. Si vous souhaiter conditionner l'affichage de toute une rubrique (titre + ses paragraphes etc.) nous vous conseillons d'utiliser le système de [[SmartDoc/Blocs|"BLOC"]] : le bloc contiendra l'ensemble de la rubrique et la condition d'affichage portera directement sur le bloc ;<br />
<br />
<br />
== Intégrer une référence dynamique vers un titre ==<br />
<br />
<br />
Vous pouvez à tout moment intégrer dans votre contenu une référence dynamique vers un titre du document.<br />
<br />
Notez qu'il existe deux types de référence dynamiques : <br />
:: - Celles qui référencent un titre du document courant : nommée "référence interne" ;<br />
:: - Et celles qui font référence à un titre d'un autre document, nommée "référence externe" ou "référence inter-document" ;<br />
<br />
<br />
=== 1 - Identifier le titre ===<br />
<br />
[[Fichier:Id-title.png|vignette|left|Exemples de titres portant des "identifiants" uniques afin qu'ils puissent être référencés .|redresse=1.25]]<br />
<br />
Pour pouvoir faire une référence à un titre, il est d'abord nécéssaire de donner un "identifiant unique" au titre vers lequel la référence doit porter.<br />
Pour cela, on utilise l'option <code>title-id</code> sur l'élément de contenu correspondant, en plus de l'option <code>title-level</code> décrite précédemment. Evitez d'intégrer des espaces ou des caractères spéciaux dans vos identifiants de titre car cela peut compliquer l'écriture des références. Ex: <code>title-id: mon-super-titre</code><br />
<br />
''<b>Rappel :</b> dans un SmartDoc, pour qu'un élément soit affichés comme un titre, il doit porter l'option <code>title-level</code> avec une valeur comprise entre 1 et 6 selon le niveau de titre (titre de premier niveau, de 2ème niveau etc.). Ex : <code>title-level: 1</code>''<br />
<br />
<br />
=== 2 - Intégrer la référence ===<br />
<br />
Vous pouvez faire référence à un titre dans votre contenu en utilisant :<br />
<br />
— <b>Pour une référence vers un titre interne au document</b>, utilisez l'opérateur spécial <code>@ref</code>. Cet opérateur doit être accompagné d'un paramètre obligatoire : le '''title-id''' du titre à référencer. Chaque paramètre étant séparé par le signe <code>:</code>, la syntaxe d'une référence interne prend la forme de : <code>{ @ref : title-id }</code>. <br />
<br />
— <b>Pour une référence vers un titre présent dans un autre document</b>, utilisez l'opérateur spécial <code>@ref-ext</code>. Cet opérateur doit être accompagné de 2 paramètres obligatoires : le '''doc-id''' du document vers lequel porte la référence, puis le '''title-id''' du titre à référencer dans ce document externe. Chaque paramètre étant séparé par le signe <code>:</code>, la syntaxe d'une référence externe prend la forme de : <code>{ @ref-ext : doc-id : title-id }</code>. <br />
<br />
<br />
:: '''''Exemple de contenu utilisant une référence interne :''''' <br />
:: <pre>Le décret énonce les différents cas pris en compte par la procédure. Voir : { @ref:article-truc }</pre><br />
<br />
:: '''''Exemple de contenu utilisant une référence externe : ''''' <br />
:: <pre>Voir annexe : { @ref:annexe1:article-truc }</pre><br />
<br />
<br />
=== 3 - Formater la référence ===<br />
<br />
Que ce soit une référence interne ou une référence externe, vous pouvez vouloir afficher la référence au titre de plusieurs façon : seulement la numérotation du titre, seulement le titre, la numérotation du titre ainsi que ces parents (1-5-2) etc. <br />
<br />
Par défaut, l'intégration d'une référence affiche la numérotation suivi du titre mais il est possible de personnaliser l'affichage : <br />
<br />
:: '''— N'afficher que la numérotation :'''<br />
<br />
:: Utiliser le transformateur <code>:num</code> comme dernier paramètre pour n'afficher que la numérotation. <br />
:: <pre> Comme indiqué à l'article {@ref:article-truc:num} du contrat, il faut recourir à une procédure de ...</pre><br />
:: De même pour une référence externe : <br />
:: <pre> Voir article { @ref-ext:mon-doc:article-truc:num } de l'annexe.</pre><br />
<br />
<br />
:: '''— N'afficher que le titre :'''<br />
<br />
:: Utiliser le transformateur <code>:title-only</code> comme dernier paramètre pour n'afficher que le titre sans sa numérotation. <br />
:: <pre> Dans notre article "{@ref:article-truc:title-only}" nous expliquons comment le ...</pre><br />
<br />
<br />
:: '''— Affichage totalement personnalisé :'''<br />
<br />
:: Utiliser le transformateur <code>:format("xxx")</code> pour formater vous même l'affichage de la référence.<br />
:: Il faudra spécifier (à la place des ''xxx'') une chaîne de caractère décrivant le format souhaité. <br />
:: Cette chaîne répond à la même syntaxe que celle de l'option de document <code>title-num-display</code> ([[SmartDoc|documentation ici]]) où $1 (et $2, $3 ... $6) font référence à l'index de numérotation d'un titre et permettent ainsi de personnaliser le système de numérotation (Exemple : pour un titre placé au ''9-7-1'' d'un document, <code>$1</code> vaut 9, <code>$2</code> vaut 7, et <code>$3</code> vaut 1). <br />
<br />
:: Utilisez aussi ce transformateur <code>:format</code> pour mettre en forme votre référence en la préfixant d'un terme, ou en personnalisant les signes séparateurs. <br />
<br />
:: Exemple de contenu : <br />
:: <pre> En référence à l'{ @ref:mon-titre:format("Art. $3.$2") } du code de ...</pre><br />
:: Ce qui affichera "''En référence à l'<u>Art 6.4</u> du code de ...''" (pour un titre ayant l'identifiant "''mon-titre'''" dans le document et qui serait le 2ème titre visible du niveau 4, lui-même enfant du 6ème titre visible de niveau 3). <br />
<br />
:: Autre exemple d'intégration personnalisée : <br />
:: <pre> En vous référant à la {@ref:section-bidule:format("section $3 (article $1.$2)")}, vous trouverez ... </pre><br />
:: Qui affichera quelque chose comme : "''En vous référant à la <u>section 12 (article 3.4)</u>, vous trouverez ...''"</div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=937SmartExpressions2020-10-06T11:37:34Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
=== Applications ===<br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== addition de deux dates =====<br />
<br />
# Fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Un nombre, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Ajouter 3 années à une date de signature </p><br />
<p><code>date_sum(DATE_SIGNATURE,3,year)</code></p><br />
<p>La Dynvar ainsi paramétrée renverra la date d'arrivée en ajoutant 3 années à la date de signature</p><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/09/2004</p><br />
<p><code>date_diff(DATE_SIGNATURE,09/09/2004,year)</code> </p><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=Twig&diff=936Twig2020-10-01T15:13:26Z<p>Léo : </p>
<hr />
<div><br />
Le Twig est un format de modélisation d'HTML à partir de données dynamiques. <br><br />
Sa documentation technique est accessible [https://twig.symfony.com/doc/2.x/templates.html sur ce lien] : https://twig.symfony.com/doc/2.x/templates.html.<br />
<br />
Les pages web dynamiques, qui peuvent être créées au format Twig dans yoprocess, sont en réalité un cumul de diverses technologies pré-packagées ensemble : le moteur Twig pour le traitement de la donnée dynamique, du HTML pour la structure de la page, des class CSS pré-définies sur YoProcess etc. <br />
<br />
== Penses-bête ==<br />
<br />
Voici quelques explications sur les classes CSS et éléments HTML élémentaires qui peuvent être utilisées lors de la création d'une page web dynamique.<br />
<br />
<br />
=== La grille ===<br />
<br />
La grille HTML permet de placer les éléments les uns à côté des autres (ligne et colonne) de façon à construire la structure de la page en prenant en compte une adaptabilité automatique selon la taille de la fenêtre du navigateur ou l'appareil (mobile, tablette etc.). <br />
La grille est indiquée en plaçant une classe `grid` sur un élément HTML (ex : <code>&lt;div class="grid"></code>). <br />
<br />
À l'intérieur de cet élément, il est possible de définir des rangées, et chacune d'elle peut contenir une ou plusieurs colonnes.<br />
Une rangée est définie par la classe <code>row</code> (ex : <code>&lt;div class="row"></code>).<br />
<br />
À l'intérieur de l'élément correspondant à une rangée, une colonne est définie par un élément HTML <code>cell-?</code> ou le <code>?</code> est un nombre de 1 à 12 inclus. Chaque rangée est constituée de 12 unités de largeur. <br />
<br />
Exemple de deux colonnes de mêmes tailles : <br />
<pre><br />
<div class="row"><br />
<div class="cell-6">Ma colonne 1</div><br />
<div class="cell-6">Ma colonne 2</div><br />
</div><br />
</pre><br />
<br />
'''Nb :''' la somme des éléments <code>cell-</code> d'une rangée doit toujours valoir 12 unités. <br />
<br />
'''Le responsive :''' la grille permet de gérer automatiquement la "responsiveness" des éléments de la page. Par exemple, un bloc `cell-6` occupera la moitié (6/12) de l'espace sur un écran normal, mais sera extrapolé pour utiliser 100% de l'espace sur un écran plus petit, faisant passer les blocs suivants en dessous. Il est possible d'utiliser les classes d'ordination de [https://material.io/develop/web/components/layout-grid/ Material Web Components Layout], de la forme <code>layout-grid__cell--order-<INDEX></code> pour indiquer l'ordre d'un élément par rapport à un autre lors des réorganisations automatiques dûes à la taille de l'écran (ex : des colonnes qui passent les unes en dessous des autres).<br />
<br />
=== Les classes CSS pré-définies ===<br />
<br />
De nombreuses classes sont pré-définies et permettent de styliser les divers éléments de la page web dynamique. Voici les plus élémentaires :<br />
<br />
* <code>surface elv1</code> : permet de passer le fond d'un élément en blanc et de rajouter les ombrages correspondant à une "élévation" basse. Ces deux classes sont utilisées pour créer le typique bloc blanc de contenu. <br />
<br />
* <code>m-?</code> ou <code>p-?</code> : permet de définir en pixel les 4 marges CSS d'un élément (margin = marge externe, padding = marge interne). Le ? peut être remplacée par un nombre parmi ceux de la liste suivante : 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 15, 16, 17, 20, 24, 25, 30, 35. <br />
<br />
* <code>mt-?</code>, <code>pb-?</code> (variantes top / bottom / left / right) : pour modifier seulement 1 des marges d'un éléments il suffit d'accoler un "t" (top), un "b" (bottom), un "l" (left), ou un "r" (right), au "m" (margin) ou au "p" (padding) tel que défini précédemment. Ex : <code>mt-16</code> rajoutera une marge supérieure de 16px. Autre exemple : <code>p-0 pr-8</code> indique que les 4 marges internes sont nulles (0px) sauf la marge de droite qui prend 8px.<br />
<br />
* <code>text-center</code> : permet de centrer le texte dans un bloc. Variantes existantes : <code>text-justify</code>, <code>text-left</code>, <code>text-right</code>. <br />
<br />
* <code>bold</code>, <code>italic</code>, <code>underline</code>, <code>uppercase</code> : leur nom est explicite, ils sont cumulables sur un même élément. <br />
<br />
* <code>grey-text</code>, <code>warning-text</code>, <code>danger-text</code>, <code>info-text</code>, <code>success-text</code>, <code>primary-text</code> : passe le texte dans la couleur correspondante. Respectivement : gris, orange, rouge, bleu, vert, et couleur-par-défaut de l'application (ex : sur YoProcess, le bleu Yo).<br />
<br />
<br />
=== Intégrer des SmartDocs ===<br />
<br />
Certains bouts de code Twig (''helpers'') ont été prévus pour facilement intégrer un lien vers les options de téléchargement des SmartDocs. <br />
<br />
Exemple : intégration d'un bandeau SmartDoc avec options par défaut de téléchargement pdf et docx <br />
[[Fichier:SmartDoc dans un modèle Twig.png|vignette|droite|Exemple d'intégration d'un SmartDoc dans une page web dynamique (modèle Twig)]]<br />
<pre><br />
{% <br />
include '@helpers/doc-row.html.twig' with {<br />
doc_id: 'contrat-travail',<br />
doc_name: "Contrat de travail"<br />
} <br />
%}<br />
</pre><br />
<br />
Exemple : intégration d'un smartdoc avec des options facultatives <br />
<br />
<pre><br />
{% <br />
include '@helpers/doc-row.html.twig' with {<br />
doc_id: 'contrat-travail',<br />
doc_name: "Contrat de travail",<br />
formats: ['pdf'],<br />
separator: 'none',<br />
custom_class: 'pt-24'<br />
} <br />
%}<br />
</pre><br />
<br />
* "doc_id" : permet de spécifier l'identifiant sur SmartDoc à intégrer dans la page web dynamique. (obligatoire)<br />
* "doc_name" : permet de spécifier le nom d'affichage du document. (obligatoire)<br />
* "formats" : permet de spécifier sous forme d'un tableau le ou les formats de téléchargement à afficher parmi "pdf" et "docx". Par défaut : <code>['pdf', 'docx']</code> <br />
* "separator" : permet d'indiquer si un séparateur horizontal doit s'afficher. 3 options possibles : "bottom" (l'afficher au dessous), "top" (l'afficher au dessus), et "none" (ne pas l'afficher). Valeur par défaut : "bottom" <br />
* "custom_class" : permet de spécifier des classes CSS à rajouter sur l'élément. Pratique pour par exemple rajouter des paddings et gérer automatiquement l'espacement entre chaque bandeau de SmartDoc. Option facultative, avec aucune valeur par défaut.<br />
<br />
=== Intégrer des conditions ===<br />
<br />
@TODO / @TOCOMPLETE<br />
<br />
<p>Le format Twig permet d'intégrer des conditions, à l'instar d'un [[Fichier de Paramétrage]].</p><br />
<p>Néanmoins, la syntaxe n'est pas tout à fait la même.</p><br />
<br />
==== Base syntaxique ====<br />
<br />
<p>On ouvrira une condition de la manière suivante : </p><br />
<pre><br />
{% if (CONDITION) %}<br />
</pre><br />
<br />
<p>On fermera sa condition de la manière suivante : </p><br />
<pre><br />
{% endif %}<br />
</pre><br />
<br />
<p>Il est aussi possible d'utiliser l'expression suivante ("sinon") pour gérer tous les cas non prévus dans la condition initiale : </p><br />
<pre> <br />
{% else %} <br />
</pre><br />
<br />
==== Précisions ====<br />
<br />
<p>Pour mettre au point une condition, il est possible d'utiliser tout type de [[Dynvars|Dynvar]] ou de [[DataStore|Variable]].</p><br />
<br />
<p>On notera que le signe <code>=</code> doit toujours s'écrire en double : <code>==</code></p><br />
<br />
<p>Par exemple :</p><br />
<pre><br />
{% if (CIVILITE == "Monsieur" %}<br />
<p>Vous êtes un homme</p><br />
{% endif %}<br />
</pre><br />
<br />
<p>Concernant les contains, les conditions doivent être formées légèrement différemment</p><br />
<p>La syntaxe à adopter sera la suivante : </p><br />
<br />
<pre><br />
{% if ("Valeur" in VARIABLE) %}<br />
<p>Vous êtes un homme</p><br />
{% endif %}<br />
</pre><br />
<br />
<p>Par exemple : </p><br />
<br />
<pre><br />
{% if ("Chasse" in HOBBIES) %}<br />
<p>Vous êtes un chasseur</p><br />
{% endif %}<br />
</pre><br />
<br />
<br />
=== Intégrer une liste de SmartDocs ===<br />
<br />
@TODO / @TOCOMPLETE <br />
<br />
Ex : <br />
<pre><br />
{% <br />
include '@helpers/smartdocs-list.html.twig' with {<br />
formats: ['pdf'],<br />
separator: 'none',<br />
custom_class: 'pt-24',<br />
exclude: ['contrat-machin'] <br />
} <br />
%}<br />
</pre><br />
<br />
=== Intégrer des pièces uploadées ===<br />
<br />
'''Afficher un bandeau de téléchargement d'une pièce PDF uploadée via un SmartForm : '''<br />
<pre><br />
{% include '@helpers/form-attachment-row.html.twig' with {<br />
att_name: "Pièce d'identité",<br />
form_id: 'infos_employee',<br />
form_field_id: 'pieces.infos.area-0.ID_RECTO'<br />
} %}<br />
</pre><br />
<br />
* "att_name" : permet d'indiquer le libellé de la pièce. (obligatoire)<br />
* "form_id" : permet d'indiquer l'identifiant du SmartForm concerné. (obligatoire)<br />
* "form_field_id" : permet d'indiquer le chemin d'identification du champ de formulaire (obligatoire)<br />
<br />
<br />
=== Intégrer des SmartForms ===<br />
<br />
@TODO / @TOCOMPLETE <br />
<br />
'''Renvoyer vers le sommaire du formulaire qui a débouché sur la page-web-dynamique (twig) actuelle, en vue-externe : '''<br />
Nb : le formulaire sera en "lecture seule" s'il a été soumis.<br />
<pre><br />
{{ path("shared_sf_summary", { token: token.token, open: 1} ) }}<br />
</pre><br />
* L'option "open" est facultative, si elle est précisé et qu'elle a une valeur "truthy" (ex : 1), alors le sommaire du formulaire sera visible en "tout ouvert" par défaut. <br />
<br />
'''Renvoyer vers le formulaire spécifié, en conservant le type d'accès actuel (externe, connecté etc.) : '''<br />
@TODO<br />
<pre><br />
{{ smartform_link("default", { open: 1, path: "employer.infos" } ) }}<br />
</pre></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=935SmartExpressions2020-09-29T11:38:14Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
=== Applications ===<br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== addition de deux dates =====<br />
<br />
# Fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Un nombre, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Ajouter 3 années à une date de signature </p><br />
<p><code>date_sum(DATE_SIGNATURE,3,year)</code></p><br />
<p>La Dynvar ainsi paramétrée renverra la date d'arrivée en ajoutant 3 années à la date de signature</p><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/09/2004</p><br />
<p><code>date_diff(DATE_SIGNATURE,09/09/2004,year)</code> </p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/09/2004</p><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léohttps://wiki.hercule.co/index.php?title=Fields-Form&diff=934Fields-Form2020-09-25T15:35:11Z<p>Léo : </p>
<hr />
<div><h1 id="fields-form">Fields-Form</h1><br />
<p>Le Fields-Form permet de mettre au point un questionnaire intelligent.</p><br />
<p>Celui-ci peut varier dynamiquement en fonction des réponses apportées par l’utilisateur.</p><br />
<p>Les réponses apportées par l’utilisateur pourront aussi servir à façonner les documents produits par le système, où à en déterminer l’existence même.</p><br />
<h2 id="section-id">Section ID</h2><br />
[[Fichier:Wiki-sections.png|vignette|right|Schéma récapitulatif de l'imbrication des différents types de section d'un SmartForm |redresse=0.75]]<br />
<p>Il s’agit ici de relier la question qui sera posée à l’utilisateur à la slide correspondante : voir [[Sections-Form|ici]]</p><br />
<p>Remplir cette colonne est obligatoire : chaque question doit impérativement être reliée à une slide.</p><br />
<h2 id="var-id">Var ID</h2><br />
<p>Le système requiert que la réponse donnée par l’utilisateur lors du remplissage du formulaire soit stockée dans une variable.</p><br />
<p>Cette dernière doit au préalable être déclarée dans le [[DataStore]].</p><br />
<h2 id="type">Type</h2><br />
<p>Le type de variable conditionne le format par lequel l’utilisateur final répondra au questionnaire.</p><br />
<p>On choisira donc un type de variable plutôt qu’un autre en fonction de la réponse qu’on attend de l’utilisateur final.</p><br />
<p>A noter : ce type doit être impérativement compatible avec le type renseigné dans la feuille “[[DataStore]]”.<br />
On peut se reporter au tableau ci-dessous pour s&#39;assurer de la compatibilité.</p><br />
<p><br />
[[Fichier:Tablecompatibilite.png|frame|none|La table de compatibilité]]<br />
</p><br />
<p>Les types de variables sont :</p><br />
<ul><br />
<li>textinput </li><br />
<li>textarea</li><br />
<li>choices-bloc</li><br />
<li>choices-list</li><br />
<li>choices-modal</li><br />
<li>fileinput</li><br />
<li>numberinput</li><br />
<li>dateinput</li><br />
</ul><br />
<p>En détail :</p><br />
<h3 id="textes">Textes</h3><br />
<h4 id="textinput-">textinput :</h4><br />
<p>propose un champ de texte “simple” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse courte <br />
[[Fichier:DS.png|frame|none|Le type "textinput"]]<br />
</p><br />
<h4 id="textarea-">textarea :</h4><br />
<p>propose un champ de texte “‘élargi” à l’utilisateur → le nombre de caractères que peut contenir la réponse est illimité, le format de réponse invite toutefois l’utilisateur à une réponse plutôt longue<br />
[[Fichier:Preambule.png|frame|none|Le type "textarea"]]<br />
</p><br />
<h3 id="choix">Choix</h3><br />
<p>Les types “choices” permettent tous de proposer des choix à l’utilisateur pour qu’il réponde à la question posée. Ce qui diffère entre les “choices” est d’ordre graphique et ergonomique : </p><br />
<h4 id="choices-bloc-">choices-bloc :</h4><br />
<p>les choix apparaissent sous forme de blocs rectangulaires cliquables<br />
[[Fichier:Choices bloc.png|frame|none|Le type "Choices-bloc"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a peu de choix à proposer à l'utilisateur, c'est-à-dire 2 ou 3 choix.</p><br />
</p><br />
<h4 id="choices-list-">choices-list :</h4><br />
<p>les choix apparaissent sous forme de boutons radios<br />
[[Fichier:Capture d’écran 2019-07-24 à 15.10.35.png|frame|none|Le type "Choices-List"]]<br />
<p>'''Conseil d'utilisation : '''utiliser ce type lorsqu'il y a quelques choix à proposer à l'utilisateur.</p><br />
</p><br />
<h4 id="choices-modal-">choices-modal :</h4><br />
<p>Les choix apparaissent dans une fenêtre modale (pop-in)</p><br />
<p>La fenêtre modale permet en plus à l'utilisateur de rechercher une valeur</p><br />
<p><br />
[[Fichier:Exemple d'une choices modal.png|400px|thumb|none|Le type "Choices-modal]]<br />
</p><br />
<p>'''Conseil d'utilisation : '''Ce champ est recommandé pour les listes de grande taille (ex : liste de tous les pays, liste des villes d’immatriculation au RCS, liste des greffes de TC, etc ...)</p><br />
<p>'''À noter : '''<br />
<p>Pour une question de type “choices”, on peut facultativement remplir le champ [[Fields-Form#Multiple-choices|multiple-choices]], dont le fonctionnement est détaillé après. </p><br />
<p>Le champ “Choices” doit en revanche être obligatoirement rempli.</p><br />
<h3 id="upload">Upload</h3><br />
<h4 id="fileinput-">fileinput :</h4><br />
<p>l’utilisateur est invité à téléverser un fichier<br />
[[Fichier:Fileinput.png|frame|none|Le type "fileinput"]]<br />
</p><br />
<h3 id="nombres">Nombres</h3><br />
<h4 id="numberinput-">numberinput :</h4><br />
<p><br />
l'utilisateur doit rentrer un nombre, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<h3 id="dates">Dates</h3><br />
<h4 id="dateinput-">dateinput :</h4><br />
<p>l’utilisateur doit rentrer une date, le système refusera tout autre type de réponse et empêchera l’utilisateur de continuer à remplir le questionnaire si autre chose est rentré dans le champ de réponse</p><br />
<p><br />
[[Fichier:Date fields form.png|200px|thumb|néant|Un champ de type "dateinput"]]<br />
<h3 id="nombres">Affichage de texte</h3><br />
<h4 id="numberinput-">static-html :</h4><br />
<h5 id="intro">Introduction</h5><br />
<p>Le champ static-html permet de montrer à l'utilisateur une information, sans lui demander de rentrer une information.</p><br />
<p>Par exemple : une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
[[Fichier:Static html exemple.png|650px|thumb|néant|Une information dynamique, qui ne sera montré à l'utilisateur que s'il rentre un montant de salaire inférieur au SMIC<br />
]]<br />
</p><br />
<h5 id="instructions">Instructions de paramétrage</h5><br />
<h6 id="gen">Instructions générales</h6><br />
<p>Par rapport aux autres champs, le paramétrage d'un static-html recèle quelques spécificités.</p><br />
<p>Tout d'abord, la colonne "Var id" ne doit pas être renseigné.</p><br />
<p>En conséquence, les colonnes Multiple-choices, required, ne doivent pas être remplies non plus.</p><br />
<p>La colonne Visible If peut être utilisée comme d'habitude pour déclencher le champ static-html de manière dynamique.</p><br />
<p>La colonne Label doit contenir du code HTML.</p><br />
<p>La colonne Label peut contenir des variables et des dynvars, utilisées entre accolades <code>{ }</code>.</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 16.21.01.png|950px|thumb|none|Un exemple de static-html. Notez bien la présence des colonnes vides, qui doivent le l'être pour ne pas causer de dysfonctionnements sur le static-html.]]<br />
<h6 id="code">Code HTML à copier/coller pour créer vos zones d'alertes</h6><br />
[https://docs.google.com/spreadsheets/d/1Axj1ihDdyVhb0oHwzdgquz_PvhS4hfIsS9zy3VCjTl0/edit?usp=sharing Cliquez ici pour accéder à notre banque de codes HTML à copier/coller]<br />
<p>À noter : la plupart des codes HTML ne fonctionnent que sur YOProcess. YoLab n'est pas encore capable de les montrer.</p><br />
<h2 id="multiple-choices">Multiple-choices</h2><br />
<p>Ce champ ne peut être rempli que dans le cas où la variable est de type “choices”</p><br />
<p>Si un '''Y''' est rentré dans le champ, l’utilisateur peut cumuler les choix mis à sa disposition.</p><br />
<p>Si un '''N''' est rentré dans le champ, l’utilisateur ne peut choisir qu’un seul choix parmi ceux mis à sa disposition. → c’est aussi le comportement par défaut si le champ est laissé vide.</p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-12 à 15.10.00.png|400px|thumb|néant|Un champ de type "choices-modal" et multiple choices. Plusieurs pays sont sélectionnés.]]<br />
<p>'''À noter : '''<br />
<p>'''La variable qui doit recevoir un Multiple-choices doit être de type [[DataStore#Type|List]]'''<br />
<p>'''Si on souhaite baser un [[Visible If]] à partir d'une variable Multiple-choices, la syntaxe à utiliser est le [[Conditions#Le_cas_sp.C3.A9cifique_des_questions_multi-choix|contains]]'''<br />
<h2 id="required">Required</h2><br />
<p>3 valeurs sont autorisés pour ce champ : </p><br />
<p><strong>optional :</strong> l’utilisateur peut ne pas répondre à la question, sans aucune conséquence</p><br />
<p><strong>necessary :</strong> l’utilisateur peut ne pas répondre à la question, mais cette absence de réponse est prise en compte pour déterminer la complétion du questionnaire.</p><br />
<p><strong>mandatory :</strong> l’utilisateur est obligé de répondre à la question pour pouvoir passer à la suite du formulaire</p></p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="label">Label</h2><br />
<p>Le “libellé” : c’est l’intitulé de la question qui sera posée à l’utilisateur.</p><br />
<p>Remplir cette colonne est obligatoire.</p><br />
<h2 id="sublabel">SubLabel</h2><br />
<p>Information complémentaire du libellé (écrite juste en dessous) et facultative.</p><br />
<p><br />
[[Fichier:Helplanation 2.png|500px|thumb|néant]]<br />
<h2 id="choices">Choices</h2><br />
<p>Il est obligatoire de remplir cette colonne si la variable est de type “choices”.</p><br />
<p>Cette colonne permet de définir les choix qui seront proposés à l’utilisateur lors du questionnaire.</p><br />
<p>Il y a en réalité deux méthodes pour définir les choix proposés à l’utilisateur : </p><br />
<h3 id="m-thode-1-classique-">Méthode 1 : “classique”</h3><br />
<p>Remplir directement la colonne en suivant précisément le format suivant :<br />
<code>chx1: Choix1;<br />
chx2: Choix2;<br />
chx3: Choix3;</code></p><br />
<p>Le premier segment de caractères ne sera jamais vu par l’utilisateur final : il s’agit simplement de la valeur enregistrée dans le système (dans la machine) lorsque l’utilisateur choisit cette réponse. → cette valeur doit d’ailleurs correspondre à ce qui est enregistré dans le [[DataStore]], dans la colonne “contrôle d’intégrité”</p><br />
<p>Le second segment de caractères est celui qui sera vu par l’utilisateur final et sur lequel il pourra cliquer pour faire son choix.</p><br />
<h3 id="m-thode-2-feuille-d-di-e-">Méthode 2 : “feuille dédiée” (méthode Choice-List)</h3><br />
<p>Dans les cas où la liste des choix est longue, il est plus simple de les organiser dans un tableau Excel et d’indiquer dans la colonne “Choices” qu’on souhaite faire appel à ce tableau.</p><br />
<p>Comment faire ?</p><br />
<p><strong>Création &amp; remplissage d’une nouvelle feuille dans le fichier de paramétrage</strong></p><br />
<p>Il faut créer une nouvelle feuille au sein du fichier de paramétrage, dont le nom sera formé de la manière suivante : <code>Choice-List “NomDuTableau”</code>, où NomDuTableau est à remplacer par le nom qu’on souhaite donner à cette feuille.</p><br />
<p><strong>Par exemple</strong></p><br />
<p><br />
[[Fichier:Capture d’écran 2019-09-02 à 10.59.01.png|300px|sans_cadre|néant]]<br />
<p>La feuille doit être divisé en deux colonnes : <code>Value</code> &amp; <code>Label</code><br />
[[Fichier:Value and Label.png|frame|none|Créer une choice-list longue]]<br />
</p><br />
<p>La colonne Label correspond au choix qui sera vu par l’utilisateur.</p><br />
<p>La colonne Value correspond à ce qui sera effectivement enregistré par la machine : ce sont donc les valeurs de cette colonne qui devront être utilisées pour mettre au point d’éventuels [[Conditions|Visible Ifs]].</p><br />
<p>Par exemple : liste de pays<br />
[[Fichier:Liste des pays.png|frame|none|La liste de tous les pays du monde.]]<br />
</p><br />
<p><br />
<strong>Astuce</strong> : effectuer une recherche sur n'importe quel moteur de recherche en spécifiant : "Le nom de la liste recherchée" + "CSV", pour récupérer des listes déjà faites dans divers domaines. Par exemple, pour [[Fields-Form/choice-list-recherche|trouver une liste de nationalités]]<br />
</p><br />
<p><strong>Appel de cette feuille à partir de la colonne “choices”</strong></p><br />
<p>Pour indiquer au système que l’ensemble des choix doit se baser sur la feuille précédemment créé, il suffit de remplir la colonne choices de la manière suivante : @source: NomDuTableau.</p><br />
<p>Par exemple : pour faire appel à la liste de pays <br />
[[Fichier:Appel choices.png|frame|none|L'étape finale : appeler la liste Choices]]<br />
</p><br />
<h2 id="info">Info</h2><br />
<p>''Colonne sans utilité pour le moment''</p><br />
<h2 id="placeholder">Placeholder</h2><br />
<p>Cette colonne permet de définir un placeholder.</p><br />
<p>Un placeholder est une réponse présente dans un champ de manière "factice" : dès que l'utilisateur aura commencé à remplir le champ, le placeholder disparaîtra</p><br />
<p>Remplir cette colonne est facultatif et ne peut être remplie que si le type de la variable est : <code>textinput</code>, <code>textarea</code>, <code>numberinput</code>, <code>dateinput</code>, ou <code>choices-modal</code>.</p><br />
<p><br />
[[Fichier:Placeholder exemple sur textinput.png|350px|thumb|néant|Le placeholder indique '15H30" pour préciser sous quel format l'heure doit être entrée.]]<br />
<h2 id="help">Help</h2><br />
<p>Cette colonne permet de définir un texte additionnel d'aide, qui apparaîtra en dessous du champ de saisie</p><br />
<p>On l'utilise généralement pour préciser des informations sur la saisie à proprement parler : nombre de caractères maximum ou minimum, nombre minimum, etc ...</p><br />
<p>Si ces [[DataStore#Contr.C3.B4le_d.E2.80.99int.C3.A9grit.C3.A9|contrôles d'intégrité]] affectent ce champ, il est fortement recommandé de le préciser ici.</p><br />
<p>Remplir cette colonne est facultatif.</p><br />
<h2 id="visible-if">Visible if</h2><br />
<p>Le champ Visible if permet de conditionner l’apparition d’une question.</p><br />
<p>Son fonctionnement est similaire au reste du système et est décrit sur cette [[Conditions|page]].<br />
<h2 id="fieldclasses">Fieldclasses</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="icon">Icon</h2><br />
<p>''Coming Soon''</p><br />
<h2 id="autonext">Autonext</h2><br />
<p>Le mode autonext peut être activé sur les champs “choices” et lorsque la colonne multi-select a été définie en “N”.</p><br />
<p>Si Autonext est à Y (yes), au choix de la réponse, le curseur de l’utilisateur passe directement au champ suivant.</p><br />
<p>Si il n’y a pas de champ après cette question (fin du formulaire, de la section, ou autre), alors la section est automatiquement soumise, c’est-à-dire confirmée et transmise au système.</p><br />
<h2 id="blockclasses">Blockclasses</h2><br />
<h3 id="reduction">Réduction de la taille des champs</h3><br />
<h4 id="mid-size">Mid-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>mid-size nobreak</code>, qui permet de diviser par deux la taille prise par un champ.</p><br />
<p> Ainsi, deux champs qui se suivent et qui ont tous les deux la spécificité <code>mid-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.16.12.png|650px|thumb|néant|Deux questions successives, toutes deux affectées par un mid-size nobreak]]<br />
<h4 id="third-size">Third-size nobreak</h4><br />
<p> La colonne blockclasses peut recevoir l'instruction <code>third-size nobreak</code>, qui permet de diviser par trois la taille prise par un champ.</p><br />
<p> Ainsi, trois champs qui se suivent et qui ont tous les trois la spécificité <code>third-size nobreak</code> se retrouveront collés l'un à l'autre</p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.23.16.png|thumb|650px|néant|Trois questions successives, toutes trois affectées par un third-size nobreak]]<br />
<h3 id="alignementchamp">Alignement d'un champ</h3><br />
<p><code>left-sided-labels</code> permet d'aligner le champ à droite, avec son label qui restera à gauche du questionnaire</p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.48.png|thumb|650px|néant|Un champ aligné à droite, son label reste à gauche]]<br />
</p><br />
<h3 id="alignementlabel">Alignement d'un label </h3><br />
<p><code>right-justified-labels</code> permet d'aligner le label à droite.</p><br />
<p>Il est possible de combiner cela avec l'instruction <code>left-sided-labels</code></p><br />
<p><br />
[[Fichier:Capture d’écran 2020-07-29 à 17.48.52.png|thumb|650px|néant|Le champ reste à gauche et le label va à droite]]<br />
</p><br />
<h3 id="cumul">Cumul de blockclasses </h3><br />
<p> Un même champ peut subir plusieurs traitements dans sa colonne blockclasses, il suffit de séparer les différents traitements d'un espace </p></div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=933SmartDoc2020-09-22T11:32:57Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
<h3 id="Métadonnées">Métadonnées</h3><br />
<p> C'est un simple espace de commentaire </p><br />
<h3 id="Datastore">DataStore</h3><br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<h3 id="title-num-display">Options - title-num-display</h3><br />
<p>title-num-display : cette colonne permet de définir le format d’affichage pour la numérotation de chaque titre du document. Cette option attend un tableau, où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, deux attributs à configurer : style et format .</p><br />
<p><strong>Les valeurs possible pour les attributs style sont :</strong><br />
<p>&quot;upper-roman&quot; : nombre romain majuscule (I, II, III, IV etc...)</p> <br />
<p>&quot;decimal&quot; : numérotation décimale / chiffres arabes (1, 2 , 3 ...)</p><br />
<p>&quot;lower-roman&quot; : nombre romain minuscule (i, ii, iii, iv etc.)</p><br />
<p>&quot;lower-alpha” : numérotation alphabétique minuscule (a, b, c, d...)</p><br />
<p>&quot;upper-alpha&quot; : numérotation alphabétique majuscule (A, B, C, D, E)</p><br />
<p><strong>En ce qui concerne l’attributs format :</strong><br />
Il attend une chaîne de caractère dans laquelle $1, $2, $3 … $6 seront remplacés par la numérotation (au style attribué). <br />
Exemple : “Article $1.$2” peut donner “Article 3.a”.</p><br />
<p><strong>Exemple complet :</strong></p><br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
<p>Où les titres :</p><br />
<p>de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”</p><br />
<p>de niveau 2 seront de la forme : “2 Lorem ipsum ”</p><br />
<p>de niveau 3 seront de la forme : “2-5 Lorem ipsum ”</p><br />
<p>de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”</p><br />
<p>de niveau 5 seront de la forme : “a. Lorem ipsum ”</p><br />
<p>de niveau 6 seront de la forme : “ iv ) Lorem ipsum”</p><br />
<h3 id="List-Labels">List-Labels</h3><br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
<h2 id="contenu-options-styles-visible-if-commentaires">Contenu, options, styles, [[Conditions|visible ifs]], commentaires</h2><br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivants sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span<br />
</p><br />
<h4 id="spec">Fonctionnalités spéciales dans la colonne "contenu"</h4><br />
<p><code>{@line-break}</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> </p><br />
<p><code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.</p><br />
<p>Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.</p><br />
<p><code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:uppercase}</code>,</p><br />
<p><code>:num</code>Le traitement “:num” peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:num}</code>, vous...<br />
devient : Comme décrit dans la section <b>3.1.1.2</b>, vous …</p><br />
<p>Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<p><code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code></p><br />
<h4 id="le-contenu-variable-a-name-variables-a-">Comment insérer des variables dans un [[SmartDoc]] ?</h4><br />
<p>La syntaxe dynamique à l’intérieur du contenu des SmartDoc est dans un format propre à Hercule, et se distingue du reste du texte car elle est entre <code>{</code> et <code>}</code>.</p><br />
<p>Il est possible d’utiliser les variables de deux manières : en “primitive” (c'est-à-dire : sans aucun traitement) ou en appliquant une modification qu’on appelle un "traitement".</p><br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<h5 id="les-traitements">Les traitements</h5><br />
<p>Les traitements peuvent être définies comme une modification appliquée sur une primitive. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong><br />
L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<h6 id="liste-des-traitements-int-gr-s">Liste des traitements intégrés</h6><br />
<p>Pour l’instant, les traitements intégrés sont : </p><br />
<p><code>:uppercase</code> : force l’affichage d’une chaîne en majuscule</p><br />
<p><code>:lowercase</code> : force l’affichage d’une chaîne en minuscule</p><br />
<p><code>:letters</code> : uniquement pour les variables de type numérique. Converti une variable numérique en toutes-lettres.</p><br />
<p>Par exemple, écrire une variable comme suit : <code>{PRIX_TTC:letters}</code> permet d'indiquer au système que la valeur stockée dans la variable PRIX_TT devra être affichée en lettres, et non en chiffres</p><br />
<p><code>:capitalize</code> : force la majuscule sur la première lettre de chaque mot</p><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document.</p><br />
Exemple : <code>{"https://pbs.twimg.com/profile_images/1078604064437518336/xYwlu68e_400x400.jpg":img}</code><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<p><code>:french-date</code> : force la valeur d’une variable de date à s’afficher au format jj/mm/aaaa.</p><br />
<p><code>:french-datetime</code> : force la valeur d’une variable de date à s’afficher au format 30/12/1985 à 12h45.</p><br />
<p><code>:letters</code> : force la valeur d’une variable numérique à s’afficher en toutes lettres.</p><br />
<p><code>:join</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code></p><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<h3 id="styles">Styles</h3><br />
<p>La colonne Styles est facultative, et permet de traiter différemment le contenu de la ligne concernée. </p><br />
<p>A chaque traitement utilisé, on retournera à la ligne après avoir écrit un <code>;</code></p><br />
*Définir la police :<br />
<p>Le traitement “<code>font-family</code>” permet de spécifier la police utilisée. </p><br />
<p>Ce traitement peut prévoir plusieurs polices, comme un système à plusieurs détentes : si le navigateur utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...</p><br />
<p>Exemple : </p><br />
<p> <code>font-family: Times New Roman, Times, serif;</code><br />
<p>Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité.</p><br />
<p>Si le navigateur ne supporte pas cette police, on cherchera à afficher une police de la famille “Times”.</p><br />
<p>Enfin, si rien de tout cela ne marche, on cherchera à afficher une police de type “Serif”</p><br />
*Définir la taille de la police : </p><br />
<p><code>font-size: XXpt;</code><br />
<p>On remplacera XX par la taille de police souhaitée</p><br />
*Mettre en gras :<br />
<code>font-weight: bold</code></p><br />
*Mettre en italique : <br />
<code>font-style: italic;</code></p><br />
*Souligner le texte : <br />
<code>text-decoration: underline;</code></p><br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
*Aligner le texte</p><br />
<p><code>text-align: right</code><br />
<code>text-align: left</code><br />
<code>text-align: center</code><br />
<code>text-align: justify</p></code></p><br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<h3 id="visible-if">[[Conditions|Visible if]]</h3><br />
<p>Ici, les [[Conditions|visible ifs]] permettront de conditionner logiquement l’apparition du texte se trouvant dans la colonne “Contenu”<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]]</p><br />
<h3 id="utiliser-les-loops-boucles-">Utiliser les [[Boucles]]</h3><br />
<p>Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]]</p><br />
<h3 id="commentaire">Commentaire</h3><br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=SmartDoc&diff=932SmartDoc2020-09-22T11:32:06Z<p>Léo : </p>
<hr />
<div><h1 id="smartdoc">SmartDoc</h1><br />
<p></p><br />
<h2 id="introduction">Introduction</h2><br />
<p>En premier lieu, un SmartDoc doit être clairement identifié par son doc-id, qui doit être strictement le même que le doc-id spécifié dans la [[DocList]]</p><br />
<p>La nouvelle feuille du [[Fichier de Paramétrage]] qui a vocation à être un SmartDoc doit donc se nommer précisément : Doc “le_doc-id”</p><br />
<p><strong>Par exemple :</strong></p><br />
<p>Ici, la [[DocList]] mentionne un seul SmartDoc, dont le doc-id est “demo-hercule” :</p><br />
[[Fichier:DocList 1.png|frame|none|Une DocList classique]]<br />
<p>En conséquence, la feuille correspondante se nomme demo-hercule</p><br />
[[Fichier:Capture d’écran 2019-07-24 à 11.19.59.png|frame|none]]<br />
<p>Quant aux colonnes détaillées ci-dessous, elles doivent toutes obligatoirement être remplies, à l’exception de la colonne D “List Labels”</p><br />
<h2 id="metadonn-es-datastore-options-list-labels">Metadonnées, datastore, options, list labels</h2><br />
[[Fichier:Smartdoc options 1.png|sans_cadre|1200px|néant]]<br />
<h3 id="Métadonnées">Métadonnées</h3><br />
<p> C'est un simple espace de commentaire </p><br />
<h3 id="Datastore">DataStore</h3><br />
<p>[[DataStore]] : C’est l'id du [[DataStore]] auquel les variables utilisées dans le document sont associées. Par défaut, mainstore.</p><br />
<h3 id="title-num-display">Options - title-num-display</h3><br />
<p>title-num-display : cette colonne permet de définir le format d’affichage pour la numérotation de chaque titre du document. Cette option attend un tableau, où chaque clé est un niveau de titre (de 1 à 6 inclus), et pour chaque niveau, deux attributs à configurer : style et format .</p><br />
<p><strong>Les valeurs possible pour les attributs style sont :</strong><br />
<p>&quot;upper-roman&quot; : nombre romain majuscule (I, II, III, IV etc...)</p> <br />
<p>&quot;decimal&quot; : numérotation décimale / chiffres arabes (1, 2 , 3 ...)</p><br />
<p>&quot;lower-roman&quot; : nombre romain minuscule (i, ii, iii, iv etc.)</p><br />
<p>&quot;lower-alpha” : numérotation alphabétique minuscule (a, b, c, d...)</p><br />
<p>&quot;upper-alpha&quot; : numérotation alphabétique majuscule (A, B, C, D, E)</p><br />
<p><strong>En ce qui concerne l’attributs format :</strong><br />
Il attend une chaîne de caractère dans laquelle $1, $2, $3 … $6 seront remplacés par la numérotation (au style attribué). <br />
Exemple : “Article $1.$2” peut donner “Article 3.a”.</p><br />
<p><strong>Exemple complet :</strong></p><br />
[[Fichier:Gestion des titres.png|frame|none|Gestion du format des titres]]<br />
<p>Où les titres :</p><br />
<p>de niveau 1 seront de la forme : “ARTICLE 8 - Lorem ipsum”</p><br />
<p>de niveau 2 seront de la forme : “2 Lorem ipsum ”</p><br />
<p>de niveau 3 seront de la forme : “2-5 Lorem ipsum ”</p><br />
<p>de niveau 4 seront de la forme : “2-5-10 Lorem ipsum ”</p><br />
<p>de niveau 5 seront de la forme : “a. Lorem ipsum ”</p><br />
<p>de niveau 6 seront de la forme : “ iv ) Lorem ipsum”</p><br />
<h3 id="List-Labels">List-Labels</h3><br />
<p><strong>Introduction</strong></p><br />
<p>List-Labels : cette colonne permet d’effectuer une conversion entre des choix d’une variable de type “choices” du SmartForm et le SmartDoc. Autrement dit, elle permet d'établir des "dictionnaires de correspondance" permettant de faire correspondre un libellé à une valeur.</p><br />
<p>Par exemple :</p><br />
[[Fichier:List Label.png|none|frame|La gestion des List Labels]]<br />
<p>Une fois un List-Label préparé, il est possible de l'utiliser grâce au traitement Label</p><br />
<p><strong>Contexte</strong></p><br />
<p>La colonne "Choices" du `Fields-Form` vous permet de spécifier les choix qui doivent apparaitre dans le formulaire. Chaque choix :</p><br />
<p>- s'écrit sur une ligne différente, ligne qui doit se terminer par un point-virgule ;</p><br />
<p>- chaque choix s'écrit en deux parties séparées par un ":" afin d'indiquer, à gauche, la valeur à stocker en base de données (et à utiliser dans les [[Conditions|visible ifs]]) et à droite la valeur à afficher dans le formulaire. On parle de couple "valeur : libellé".</p><br />
<p>Par exemple</p><br />
<p>[[Fichier:Dg.png|thumb|none|375px]]</p><br />
</p><br />
<p><strong>Mise en place</strong><br />
<p>Le document n'est pas à même de décider sous quelle forme afficher la variable correspondante aux choix d'un champ de type "choix"</p> <br />
<p>Si rien n'est spécifié, le document affichera ce qui est stocké dans la base de données </p><br />
<p>Il est toutefois possible d'indiquer au document des libellés et pour cela intervient le filtre <code>:label(xxx)`</code>.</p><br />
<p>Par exemple, on peut imaginer un dictionnaire nommé "fonctions" pour indiquer que "dg" doit s'afficher "Directeur Général", et un autre dictionnaire nommé "fonctions_abrégées" qui indiquerait au contraire que "dg" doit s'afficher "Dir. G.".</p><br />
<p>Il sera alors possible, dans le contenu du SmartDoc, de faire appel au dictionnaire de votre choix :</p><br />
<ul><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions")}</code></li><br />
<li>- M. Dupond occupant le poste de <code>{VARFONCT:label("<br />
fonctions_abrégées")}</code></li><br />
</ul><br />
<p><br />
Les dictionnaires sont définis via la case D2 (List Labels) des onglets "Doc".</p><br />
<p>Ils sont écrits sous la forme suivante :</p><br />
<p><br />
[[Fichier:D2.png|none|thumb|175px]]<br />
<p>⚠ Notez les espaces d'indentation qui permettent d'indiquer au système l'imbrication / hiérarchie de l'info. C'est à dire qu'ici, val1 et val2 appartiennent au premier dictionnaire, alors que valA et valB appartiennent au second dictionnaire. Sans cette indentation, le système ne saurait pas reconnaitre si la ligne correspond à la déclaration d'un nouveau dictionnaire ou à un couple valeur/libellé. </p><br />
→ A noter : On peut aussi utiliser un libellé référencé dans une “[[Choice-List]]”.<br />
Par exemple, il est possible de créer un List Label nommé “countries” qu’on configurerait de la manière suivante : <code>countries: @pays</code> .</p><br />
<p>On peut alors l’utiliser de la même façon au sein d’un document avec, par exemple, <code>{PAYS_NAISS:label("countries")}</code>.<br />
<p>La colonne A qui donne France si la variable PAYS_NAISS vaut “FR”.</p><br />
<br />
<br />
<h2 id="templates-docx">Les modèles .docx</h2><br />
<br />
<br />
<br />
Le SmartDoc consiste à définir du "contenu dynamique", bien qu'il soit possible de définir certains styles de base (couleurs, gras, italiques, titres etc.), la mise en page du document lui même reste limitée. C'est en cela que les "modèles .docx" peuvent être utile.<br />
<br />
Chaque SmartDoc peut se baser sur un modèle de fichier, au format .docx. Le contenu dynamique sera tout simplement "injecté" dans le document à l'endroit indiqué.<br />
Le modèle peut, par exemple, prévoir un habillage (page de couverture, page de garde etc.), prévoir des entêtes et pieds-de-page, mais surtout, peut permettre de définir les marges du document et les styles des paragraphes et des titres (tailles, couleurs, espacement...). <br />
Le contenu dynamique, créé au travers du SmartDoc, se retrouvera simplement injecté dans le modèle prédéfini. <br />
<br />
'''Définir un modèle et l'associer à un ou plusieurs SmartDoc'''<br />
<br />
Pour pouvoir utiliser un modèle, il suffit de le rajouter dans la Doc-List, en lui donnant un identifiant unique, et en indiquant le type <code>docx-template</code> (vous pouvez aussi préciser un titre, une description). <br />
<br />
Une fois le modèle présent dans la Doc-List, il est possible de l'associer à un SmartDoc en utilisant l'option : <code>docx-template: mon-template</code>.<br />
<br />
'''Préparer son modèle et l'injection du contenu''' <br />
<br />
Le modèle .docx peut être préparé comme un document classique : définir les styles des titres et des paragraphes, définir les marges et les interlignes, une page de couverture et des pieds-de-pages etc.<br />
Pour définir où le contenu dynamique devra être injecté, il faut utiliser la syntaxe suivante : <code>${ @inject all }</code>. Ainsi, l'intégralité du contenu du SmartDoc sera intégrée à cet endroit même du modèle.<br />
Il est aussi possible de demander l'intégration d'un seul [[Blocs | bloc du SmartDoc]], en indiquant, à la place de <code>all</code>, l'identifiant du SmartDoc et le nom exact du bloc. <br />
<br />
Par exemple, dans un SmartDoc nommé <code>contrat</code>, un bloc défini par <code>#BLOC dénomination</code>, pourra être injecté dans le modèle .docx avec la syntaxe suivante :<br />
<pre>${ @inject contrats :: dénomination }</pre><br />
<br />
'''''Nb :''' notez les 2 fois 2 points (<code>::</code>) pour séparer l'identifiant du SmartDoc concerné et le nom exact du bloc à injecter.'' <br />
<br />
'''Pour aller plus loin :''' <br />
* Vous pouvez trouver plus d'informations sur les modèles docx et sur la manière de les mettre en place sur la [[Docx-template|page dédiée du Wiki]].<br />
* Il est parfaitement possible d'utiliser plusieurs injections dans un même modèle .docx. Il vous suffit d'utiliser plusieurs fois la syntaxe <code>${ @inject ... }</code> dans le document modèle.<br />
* Le contenu injecté peut lui-même inclure d'autres blocs (voir [[Smartdoc/include| les "inclusions" (includes) d'un SmartDoc]]), des boucles, des titres etc. <br />
* Dans certains cas, il peut être problématique d'injecter un bloc, lui même contenu dans [[Boucles | une boucle du SmartDoc]]. En effet, la boucle a pour conséquence de "contextualiser" la variable sur laquelle elle boucle, si vous injectez ce contenu hors de ce contexte, le SmartDoc ne saura pas comment interpréter la variable correspondante à une occurence de la boucle.<br />
<br />
<br />
<h2 id="contenu-options-styles-visible-if-commentaires">Contenu, options, styles, [[Conditions|visible ifs]], commentaires</h2><br />
[[Fichier:SmartDoc options 2.png|1200px|sans_cadre|néant]]<br />
<h3 id="contenu">Contenu</h3><br />
<p> Un SmartDoc est constitué d'une suite ordonnée d'[[Élément_de_contenu|éléments de contenu]]. Dans la feuille du tableur de paramétrage, il faut créer autant de ligne que d'éléments de contenu dynamique. On défini un nouvel élément pour lui associer une condition de visibilité spécifique (ex : car cet élément ne doit pas s'afficher dans certains cas), ou on veut lui associer un "style" spécifique (ex : mettre une partie du paragraphe en couleur rouge).</p><br />
<p>Le “contenu” du SmartDoc est ce qui sera effectivement “imprimé” dans le document final qui sera transmis à l’utilisateur.</p><br />
<p>Ce contenu, en plus d’être dynamique grâce au “visible-ifs” comme le reste du système, accepte aussi l’utilisation de variables.</p><br />
<h4 id="bases">Bases</h4><br />
<p>C’est ici qu’il faut entrer le contenu “brut” du texte : c’est-à-dire le corps du texte.</p><br />
<p>On peut se servir des [https://developer.mozilla.org/fr/docs/Apprendre/Commencer_avec_le_web/Les_bases_HTML balises HTML basiques] pour mettre en forme le texte rentré ici.</p><br />
<p>Les balises suivants sont utilisables</p><br />
<p><br />
* a, <br />
* br, <br />
* b, <br />
* strong, <br />
* i, <br />
* em, <br />
* ol, <br />
* ul, <br />
* li, <br />
* hr, <br />
* span<br />
</p><br />
<h4 id="spec">Fonctionnalités spéciales dans la colonne "contenu"</h4><br />
<p><code>{@line-break}</code> : ajout un saut de ligne : il est possible de forcer un saut de ligne (ou plusieurs) en utilisant la syntaxe suivante dans un contenu HTML : <code>{@line-break}</code><br>Plusieurs saut de ligne (par exemple 2) : <code>{@line-break:2}</code> </p><br />
<p><code>{@page-break</code>} : ajout d’un saut de page : il est possible de forcer un saut de page en utilisant la syntaxe suivante dans un contenu HTML : <code>{@page-break}</code>.</p><br />
<p>Le saut de page est effectif dans les exports .docx ou .pdf, mais est simulé par une simple ligne verticale dans les prévisualisations HTML.</p><br />
<p><code>{@ref:my title id}</code> : ajout d’une référence vers un titre : comme pour intégrer une variable, il est possible d’intégrer un lien vers un titre du document (le titre peut se trouver avant ou après la référence dans le contenu). Pour intégrer une référence, il suffit d’utiliser la syntaxe <code>{@ref:my title id}</code> pour laquelle “my title id” correspond à l’attribut title-id d’un bloc-titre existant dans le document. Le fonctionnement des références croisées est décrit en détail [[Smartdoc/titre-et-references|ici]].<br />
Nb : si plusieurs titres ont le même title-id alors la référence pointe vers le premier de la page. <br />
Nb : si la référence pointe vers un titre qui n’existe pas dans le document (ou est invisible), elle sera remplacée par le texte “[référence manquante]”. <br />
Par défaut, la référence à un titre se contente d’afficher le titre (càd, le contenu du bloc titre).<br />
Une chaine de caractère étant retournée, il est possible d’appliquer les filtres classiques.<br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:uppercase}</code>,</p><br />
<p><code>:num</code>Le traitement “:num” peut-être appliqué dans la syntaxe afin d’afficher la référence sous forme numérique et tenant compte des titres parents. <br />
Exemple : Comme décrit dans la section <code>{@ref:droit-acheteur:num}</code>, vous...<br />
devient : Comme décrit dans la section <b>3.1.1.2</b>, vous …</p><br />
<p>Pour les cas des références vers des titres ayant l’option title-article à “true” le nombre retourné sera simplement celui de l’article dans le cas du traitement “:num”.<br />
Pour les cas des références vers des titres ayant l’option title-no-count , le traitement “:num” n’aura alors aucun effet.</p><br />
<p><code>{@summary}</code>Ajout d’un sommaire automatique : il est possible d’ajouter un sommaire automatique au document (table of contents) en utilisant la syntaxe suivante : <code>{@summary}</code></p><br />
<h4 id="le-contenu-variable-a-name-variables-a-">Comment insérer des variables dans un [[SmartDoc]] ?</h4><br />
<p>La syntaxe dynamique à l’intérieur du contenu des SmartDoc est dans un format propre à Hercule, et se distingue du reste du texte car elle est entre <code>{</code> et <code>}</code>.</p><br />
<p>Il est possible d’utiliser les variables de deux manières : en “primitive” (c'est-à-dire : sans aucun traitement) ou en appliquant une modification qu’on appelle un "traitement".</p><br />
<h5 id="les-primitives">Les primitives</h5><br />
<p>Une primitive est un élément qui a une valeur.</p><br />
<p><strong>Par exemple:</strong> la variable PRENOM va valoir “Damien”. Ou tout simplement un nombre (ex: 36) ou une chaine de caractère (ex: &quot;une chaise&quot;)</p><br />
<p><strong>Pour intégrer une valeur :</strong> les variables du dataset sont intégrées dans le contenu à partir d’une syntaxe simple : la variable est placée, sans espace, entre deux accolades. <br />
Exemple :<br />
Le vendeur, né le <code>{DATE_NAISSANCE}</code>, à <code>{VILLE_NAISSANCE}</code> ... </p><br />
<h5 id="les-traitements">Les traitements</h5><br />
<p>Les traitements peuvent être définies comme une modification appliquée sur une primitive. Par exemple, le traitement <code>uppercase</code> permet de mettre en majuscule une primitive de catégorie chaîne-de-caractère. </p><br />
<p>Pour appliquer un traitement sur une primitive, on utilise le signe : <code>:</code> Ce qui donne Mon prénom est <code>{PRENOM:uppercase}</code> qui donne Mon prénom est DAMIEN même quand la variable <code>PRENOM</code> vaut “DaMien”.</p><br />
<p>Comme vu précédemment, pour intégrer une valeur avec un traitement, on procède en utilisant : <code>:</code></p><br />
<p><strong>Exemple :</strong> <br />
Le vendeur s’appelle <code>{PRENOM:uppercase}</code></p><br />
<p>Il est possible d&#39;enchaîner les traitements. </p><br />
<p><strong>Exemple :</strong><br />
L&#39;acheteur a payé <code>{PRIX:letters:uppercase}</code> euros.<br />
Ici, la valeur contenue dans la variable &quot;PRIX&quot; sera d&#39;abord convertie en lettres, puis mise automatiquement en MAJUSCULES.<br />
On obtiendra un résultat du type : &quot;L&#39;acheteur a payé TRENTE euros&quot;, alors que la valeur de départ sera &quot;30&quot;.</p><br />
<p><strong>A noter</strong> : les traitements peuvent s’appliquer aussi sur de simples chaînes de caractères et pas seulement des variables. Ex : L&#39;acheteur a payé {&quot;32 000&quot;:letters:uppercase} euros.</p><br />
<h6 id="liste-des-traitements-int-gr-s">Liste des traitements intégrés</h6><br />
<p>Pour l’instant, les traitements intégrés sont : </p><br />
<p><code>:uppercase</code> : force l’affichage d’une chaîne en majuscule</p><br />
<p><code>:lowercase</code> : force l’affichage d’une chaîne en minuscule</p><br />
<p><code>:letters</code> : uniquement pour les variables de type numérique. Converti une variable numérique en toutes-lettres.</p><br />
<p>Par exemple, écrire une variable comme suit : <code>{PRIX_TTC:letters}</code> permet d'indiquer au système que la valeur stockée dans la variable PRIX_TT devra être affichée en lettres, et non en chiffres</p><br />
<p><code>:capitalize</code> : force la majuscule sur la première lettre de chaque mot</p><br />
<p><code>:img</code> : transforme une chaine de caractère (url) en image dans le document.</p><br />
Exemple : <code>{"http://www.gouache.com/logo.png":img}</code><br />
<p><code>:num</code>: (uniquement pour les références). Pour une référence à un titre, affiche son numéro au lieu d’afficher le titre. <br />
Exemple : </code>Comme décrit dans la section {@ref:droit-acheteur:num}, vous...</code>. Le fonctionnement des références croisées est décrit en détail [[http://wiki.hercule.co:3002/index.php/Smartdoc/titre-et-references|ici]]</p><br />
<p><code>:french-date</code> : force la valeur d’une variable de date à s’afficher au format jj/mm/aaaa.</p><br />
<p><code>:french-datetime</code> : force la valeur d’une variable de date à s’afficher au format 30/12/1985 à 12h45.</p><br />
<p><code>:letters</code> : force la valeur d’une variable numérique à s’afficher en toutes lettres.</p><br />
<p><code>:join</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme suivante : <code>Valeur1, Valeur2, Valeur3, et Valeur4</code>. Les différentes valeurs contenues dans la variable sont affichées les unes à la suite des autres, séparées par des virgules; la dernière valeur est précédée de la conjonction de coordination <code>et</code></p><br />
<p><code>:list</code> : '''utilisable uniquement pour les variables [[Fields-Form|multiples-choices]]''' → permet d'afficher les différentes valeurs de la liste dans le SmartDoc sous la forme d'une liste à puce; chacune des valeurs de la liste démarre une nouvelle puce</p><br />
<p><code>:label</code> : dont le fonctionnement est expliqué [[SmartDoc#List-Labels|plus haut]].</p><br />
<p><code>:substr(x,y)</code> : permet de tronquer une chaîne de caractères. Par exemple pour une variable PRENOM qui vaudrait "Maximilien", on pourra utiliser la notation suivante : <code>{PRENOM:substr(2,4)}</code>, qui donnera en pratique "ximi" ;<br />
<h3 id="options">Options</h3><br />
*<code>break</code> (facultatif) : valeur possible <code>none</code> , <code>before</code> ou <code>after</code>.<br />
<p>Permet d’intégrer un saut de ligne. Par défaut, toutes les entrées sont en break: after.</p><br />
<p>Si after est indiqué (ou si rien n’est indiqué puisque c’est la valeur par défaut), alors le bloc se terminera par un saut de ligne et le bloc suivant s’affichera sur une nouvelle ligne.</p><br />
<p>Si before est indiqué, l’entrée s’affiche sur une nouvelle ligne (le saut de ligne intervient avant l’entrée).</p><br />
<p>Si none est indiqué, il n’y a pas de saut de ligne, les entrées s&#39;enchaînent.</p><br />
*<code>title-level</code> (facultatif) : valeurs possibles : 1, 2, 3, 4, 5, 6.<br />
*<code>title-id</code> (facultatif) : la valeur attendue est une chaîne de caractères alpha-numériques sans sauts de ligne et dont les caractères suivants sont interdits : :, {, }, &quot;<br />
<p>Cette option permet d’assigner un identifiant au titre concerné, de cette façon il sera possible de faire référence à ce titre via un “bookmark” (voir plus haut, “ajout de référence”).</p><br />
<p>Nb: cet attribut n’est possible QUE si l’attribut title-level est lui aussi renseigné.<p><br />
*<code>title-article</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”.<br />
Quand cette option est à “true”, le titre sera considéré comme un “titre d’article”. Il sera donc préfixé par &quot;ARTICLE 1 - &quot; ou le nombre “1” sera remplacé par l’index de l’article en question.</p><br />
*<code>title-no-count</code> (facultatif) : valeur booléenne attendue. Par défaut, la valeur est “false”. Quand cette option est à “true”, le titre ne sera pas numéroté, ni dans les sommaires, ni préfixe par aucun type de numérotation.<br />
<h3 id="styles">Styles</h3><br />
<p>La colonne Styles est facultative, et permet de traiter différemment le contenu de la ligne concernée. </p><br />
<p>A chaque traitement utilisé, on retournera à la ligne après avoir écrit un <code>;</code></p><br />
*Définir la police :<br />
<p>Le traitement “<code>font-family</code>” permet de spécifier la police utilisée. </p><br />
<p>Ce traitement peut prévoir plusieurs polices, comme un système à plusieurs détentes : si le navigateur utilisé ne supporte pas la première police, le système tentera d’utiliser la deuxième police, puis la troisième, ainsi de suite ...</p><br />
<p>Exemple : </p><br />
<p> <code>font-family: Times New Roman, Times, serif;</code><br />
<p>Dans cet exemple, on prévoit d’utiliser Times New Roman en priorité.</p><br />
<p>Si le navigateur ne supporte pas cette police, on cherchera à afficher une police de la famille “Times”.</p><br />
<p>Enfin, si rien de tout cela ne marche, on cherchera à afficher une police de type “Serif”</p><br />
*Définir la taille de la police : </p><br />
<p><code>font-size: XXpt;</code><br />
<p>On remplacera XX par la taille de police souhaitée</p><br />
*Mettre en gras :<br />
<code>font-weight: bold</code></p><br />
*Mettre en italique : <br />
<code>font-style: italic;</code></p><br />
*Souligner le texte : <br />
<code>text-decoration: underline;</code></p><br />
*Définir une bordure</p><br />
<p><code>border: 1px #777777 solid</code></p><br />
*Aligner le texte</p><br />
<p><code>text-align: right</code><br />
<code>text-align: left</code><br />
<code>text-align: center</code><br />
<code>text-align: justify</p></code></p><br />
*Choisir une couleur de fond pour le texte<br />
<p><code>background-color: #FFFF00</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
*Choisir une couleur pour le texte</p><br />
<p><code>color: #FF0000</code></p><br />
<p>La couleur doit être indiquée au format hexadecimal</p><br />
<h3 id="refs">[[Smartdoc/titre-et-references|Les références croisées]]</h3><br />
Les références croisées font l'objet d'une [[Smartdoc/titre-et-references|page dédiée]].<br />
<h3 id="visible-if">[[Conditions|Visible if]]</h3><br />
<p>Ici, les [[Conditions|visible ifs]] permettront de conditionner logiquement l’apparition du texte se trouvant dans la colonne “Contenu”<br />
Le fonctionnement est similaire au reste du système, et est détaillé dans la page relative aux [[Conditions|Visible ifs]]</p><br />
<h3 id="utiliser-les-loops-boucles-">Utiliser les [[Boucles]]</h3><br />
<p>Les boucles permettent de répéter un groupe d&#39;informations autant de fois que nécessaire, cette notion est détaillée dans la [[Boucles|page correspondante]]</p><br />
<h3 id="commentaire">Commentaire</h3><br />
<p>Ce champ permet à celui qui paramètre de laisser toute indication utile à la compréhension de son fichier de paramétrage.</p><br />
<p>L’utilisateur final ne verra jamais ce qui est écrit dans ce champ.</p><br />
<h2 id="autre">Autres fonctionnalités présentes dans le SmartDoc</h2></div>Léohttps://wiki.hercule.co/index.php?title=SmartExpressions&diff=931SmartExpressions2020-09-21T16:17:37Z<p>Léo : </p>
<hr />
<div>''Cette page est en cours de construction''<br />
<br />
= Introduction =<br />
<br />
On désigne par "SmartExpressions" la syntaxe permettant de paramétrer les [[Dynvars]] et les [[Conditions|Visible If]].<br />
<br />
= Paramétrage =<br />
<br />
<p>Pour mémoire : la syntaxe est basée sur PHP : https://www.php.net/manual/fr/funcref.php </p><br />
<br />
== Bases de la syntaxe ==<br />
<br />
''Cette page est encore en cours de construction''<br />
<br />
=== Principes ===<br />
<br />
<p>La syntaxe SmartExpressions permet d'effectuer des enchaînements logiques de type <code>SI ... ALORS</code> afin de déterminer des règles d'applications, ainsi que des calculs mathématiques</p><br />
<br />
<p><code>?</code> : Alors</p><br />
<p><code>:</code> : Sinon</p><br />
<p><code>or, and</code> : OU, ET</p><br />
<p><code>~</code> : Concaténation (entre plusieurs chaînes de caractères)</p><br />
<p><code>*</code><code>+</code><code>-</code><code>/</code><code>=</code><code>!=</code> : opérateurs mathématiques</p><br />
<br />
<b>Illustration</b><br />
<p><br />
[[Fichier:Smartex complexe.png|900px|thumb|néant|]]<br />
</p><br />
<p>Ici la SmartExpression utilisée signifie :</p><br />
<p>Si la variable <code>TYPE_SOCIETE</code> est égale à "Entreprise unipersonnelle à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société à responsabilité limitée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société civile", <b>ALORS</b> la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "parts sociales", sinon <b>SI</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée" <b>OU</b> si la variable <code>TYPE_SOCIETE</code> est égale à "Société par actions simplifiée unipersonnelle", alors la la [[Dynvars|Dynvar]] <code>ACTIONS_PARTS</code> devra valoir "actions"</p><br />
<br />
<b>Décomposition</b><br />
@LEO TODO<br />
<br />
<br />
=== Exemples d'application ===<br />
<br />
==== Opérations mathématiques ====<br />
<br />
<p>Les Dynvars peuvent servir à effectuer des opérations mathématiques, en utilisant les opérateurs basiques, comme par exemple : </p><br />
<p><br />
[[Fichier:Dynvar Maths.png|900px|thumb|néant|Dans cet exemple, une variable PRIX_HT est multipliée par 1.20 pour obtenir un prix TTC]]<br />
</p><br />
<p> Il est possible d'effectuer des opérations mathématiques entre plusieurs variables, et aussi entre plusieurs Dynvars.</p><br />
<p>Liste des opérateurs mathématiques pouvant être utilisés : <code>*</code><code>+</code><code>-</code><code>/</code></p><br />
<br />
==== Factorisation du raisonnement ====<br />
<br />
===== Factorisation simple =====<br />
<br />
<p>On peut aussi prévoir qu'une Dynvar prenne pour valeur <code>TRUE</code> ou <code>FALSE</code> en fonction de la valeur d'autres variables</p><br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Dynvars - true or false.png|900px|thumb|néant|Si une des deux variables vaut "france", alors la variable FISCALITE_FR vaudra "vrai".]]<br />
</p><br />
<p>Cette formule signifie : la Dynvar nommée <code>FISCALITE_FR</code> vaudra <code>TRUE</code> si <code>NATIONALITE_ACHETEUR</code> ou <code>NATIONALITE_VENDEUR</code> est égal à <code>"france"</code><br />
<p>Il sera donc possible d'utiliser la Dynvar <code>FISCALITE_FR</code> dans des [[Conditions|Visible Ifs]], ou même dans les formules d'autres Dynvars.</p><br />
<p>Pour utiliser la dynvar <code>FISCALITE_FR</code>, on utilisera donc la SmartExpression suivante : <code>FISCALITE_FR = true</code> ou <code>FISCALITE_FR = false</code><br />
<br />
===== Factorisation et chaînes de caractères =====<br />
<br />
[[Fichier:Exemple smartex complexe.png|900px|vignette|néant|La SmartExpression contenue dans cette dynvar]]<br />
<p>Dans l'exemple ci-dessus, la SmartExpression signifie : "Si la variable <code>SOCIETE_RESULTAT</code> est supérieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "bénéfice", sinon si la variable <code>SOCIETE_RESULTAT</code> est inférieure à 0, <b>Alors</b> la Dynvar <code>BENEFICE_PERTE</code> doit valoir "perte".<br />
<br />
==== Dynvars et chaînes de caractères ====<br />
<p> Une Dynvar peut avoir pour formule plusieurs chaînes de caractères, par exemple pour reconstruire un nom complet ou une phrase en utilisant plusieurs variables. </p><br />
[[Fichier:Dynvar full name bis.png|900px|vignette|néant|Une dynvar FULL_NAME qui reprend grâce à la concaténation : la civilité, le nom, et le prénom.]]<br />
<br />
== Les fonctions ==<br />
<br />
=== Principes ===<br />
<br />
<p>Une fonction prend toujours la forme suivante : <code>MA_FONCTION( xxx )</code></p><br />
<br />
</br><br />
<p>Une fonction est donc toujours composée de trois éléments :</p><br />
<p><code>MA_FONCTION</code> : on commence toujours par nommer la '''fonction''' souhaitée.</p><br />
<p><code>( )</code> : ces parenthèses dites "d'exécution" peuvent contenir plusieurs paramètres, séparés chacun par une virgule. Chaque fonction pourra avoir plus ou moins de paramètres.</p><br />
<p><code>xxx</code> : les '''paramètres''' de la fonction. Ce sont les paramètres qui vont permettre à la fonction de s'exécuter.</p><br />
<br />
=== Applications ===<br />
<br />
==== Fonctions sur les Dates ====<br />
<br />
===== addition de deux dates =====<br />
<br />
# Fonction : <code>date_sum</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Un nombre, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Ajouter 3 années à une date de signature </p><br />
<p><code>date_sum(DATE_SIGNATURE,3,year)</code></p><br />
<p>La Dynvar ainsi paramétrée renverra la date d'arrivée en ajoutant 3 années à la date de signature</p><br />
<br />
===== calcul de la différence entre deux dates =====<br />
<br />
# Fonction : <code>date_diff</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Date de début, Date de fin, Une chaîne de caractères parmi : year; month; day; hour; minute; second<br />
<br />
<p>Par exemple :</p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/09/2004</p><br />
<p><code>date_diff(DATE_SIGNATURE,09/09/2004</code> </p><br />
<p>Trouver le nombre d'années de différences entre une date de signature et la date (fixe) du 09/09/2004</p><br />
<br />
===== renvoyer automatiquement la date du jour =====<br />
<br />
''Spécificité : fonction unaire, ne possède pas de paramètres''<br />
# Fonction : <code>now()</code><br />
# Nombre de paramètres : <code>0</code><br />
# Paramètres attendus : N/A<br />
<br />
<p>Par exemple :</p><br />
<p><br />
[[Fichier:Now().png|thumb|neant|780px]]<br />
</p><br />
<br />
===== trouver automatiquement l'âge d'un individu =====<br />
<br />
# Fonction : <code>years_old</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple :</p><br />
<p><code>years_old(DATE_NAISSANCE)</code></p><br />
<br />
===== isoler le jour, le mois, l'année d'une date =====<br />
<br />
# Fonction : <code>date_day</code> <code>date_month</code> <code>date_year</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Une date<br />
<br />
<p>Par exemple : <code>date_month(DATE_SIGNATURE)</code></p><br />
<br />
===== changer le format d'une date =====<br />
<br />
# Fonction : <code>date_format</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une date, Un format de date<br />
<br />
<p>Par exemple :</p><br />
<p>Passer d'une date complète à un format jour/mois</p><br />
<p><code>date_format(DATE_NAISSANCE, "d/m")</code></p><br />
<br />
==== Fonctions sur les Nombres ====<br />
<br />
''Introduction : notez bien que les traitements sur les nombres peuvent être effectués aussi bien sur des variables que sur d'autres dynvars''<br />
<br />
===== arrondir un nombre en choisissant le nombre de chiffres souhaités après la virgule =====<br />
<br />
# Fonction : <code>round</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Un nombre, Un autre nombre<br />
<br />
''La fonction enregistre le premier nombre, puis l'arrondit en fonction du deuxième paramètre''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à 3 chiffres après la virgule</p><br />
<code>round(PRIX_ACHAT, 3)</code><br />
<br />
===== arrondir un nombre entier à l'entier inférieur =====<br />
<br />
# Fonction : <code>floor</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier inférieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier inférieur</p><br />
<code>floor(PRIX_ACHAT)</code><br />
<br />
===== arrondir un nombre entier à l'entier supérieur =====<br />
<br />
# Fonction : <code>ceil</code><br />
# Nombre de paramètres : <code>1</code><br />
# Paramètres attendus : Un nombre<br />
<br />
''La fonction attend un nombre et lui retire ses décimales en arrondissant à l'entier supérieur''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour arrondir un prix d'achat à l'entier supérieur</p><br />
<code>ceil(PRIX_ACHAT)</code><br />
<br />
==== Fonctions sur les Chaînes de caractères ====<br />
<br />
===== Comparer deux chaînes de caractères =====<br />
<br />
# Fonction : <code>contains</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du second paramètre est incluse dans la chaîne du 1er paramètre''</p><br />
<br />
<p>Par exemple :</p><br />
<code>contains(PRENOM,NOM)</code><br />
<br />
===== Trouver si une chaîne de caractères commence par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>begins_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre commence par la chaîne du second paramètre''</p><br />
<br />
===== Trouver si une chaîne de caractères se finit par une autre chaîne de caractères =====<br />
<br />
# Fonction : <code>ends_with</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), une autre Chaîne de caractères<br />
<br />
<p>''La première chaîne de caractères est la chaîne dans laquelle rechercher, la deuxième chaîne de caractère est la chaîne à rechercher''</p><br />
<p>''La Dynvar paramétrée avec cette fonction vaudra TRUE si la chaîne du premier paramètre se finit par la chaîne du second paramètre''</p><br />
<br />
===== Tronquer une chaîne de caractères =====<br />
<br />
# Fonction : <code>substring</code><br />
# Nombre de paramètres : <code>3</code><br />
# Paramètres attendus : Une Chaîne de caractères ([[DataStore|string]]), le nombre à partir duquel la fonction doit tronquer, le nombre de caractères à prendre en compte après la troncation<br />
''À noter : le troisième paramètre est facultatif. S'il n'est pas présent, la fonction renverra tous les caractères situés après la troncation''<br />
<br />
<p>Par exemple :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2, 3)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcu"</p><br />
</br><br />
<p>Ou encore :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 0, 4)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "Herc"</p><br />
</br><br />
<p>Ou enfin :</p><br />
<p>Pour une dynvar paramétrée de la manière suivante : <code>substring(DENOMINATION, 2)</code>;</p><br />
<p>Si la variable DENOMINATION vaut "Hercule";</p><br />
<p>La Dynvar ainsi paramétrée vaudra "rcule"</p><br />
<br />
==== Fonctions sur les repeaters ====<br />
<br />
===== Additionner les répétitions d'une sous-variable d'un repeater =====<br />
<br />
# Fonction : <code>list_sum</code><br />
# Nombre de paramètres : <code>2</code><br />
# Paramètres attendus : Une variable de type [[DataStore|List]] utilisée pour un [[Repeaters|Repeater]], une sous-variable du même Repeater<br />
<br />
'''Contexte'''<br />
<p>Il est parfois nécessaire d'additionner les différentes répétitions d'une même sous-variable d'un repeater.</p><br />
<p>Par exemple, dans cette situation :</p><br />
[[Fichier:List sum chemises.png|400px|vignette|néant|Une sous-variable répétée demande ici le prix d'une chemise. Comment faire pour obtenir la somme des prix de toutes les chemises ?]]<br />
<br />
'''Paramétrage'''<br />
<p>Le paramétrage prend la forme suivante :</p><br />
<p><code>list_sum(VARIABLE_LISTE,"SOUS_VARIABLE")</code></p><br />
<p>Pour obtenir le prix de toutes les Chemises dans l'exemple ci-dessus, il faudra paramétrer une [[Dynvars|Dynvar]] dont la formule sera <code>list_sum(CHEMISES,"prix")</p></div>Léo