diff --git a/locale/fr/LC_MESSAGES/rougail_output_doc.po b/locale/fr/LC_MESSAGES/rougail_output_doc.po index 2ecac83..6f674ed 100644 --- a/locale/fr/LC_MESSAGES/rougail_output_doc.po +++ b/locale/fr/LC_MESSAGES/rougail_output_doc.po @@ -5,8 +5,8 @@ msgid "" msgstr "" "Project-Id-Version: \n" -"POT-Creation-Date: 2024-11-07 21:51+0100\n" -"PO-Revision-Date: 2024-11-07 22:47+0100\n" +"POT-Creation-Date: 2024-11-20 21:02+0100\n" +"PO-Revision-Date: 2024-11-20 21:09+0100\n" "Last-Translator: \n" "Language-Team: \n" "Language: fr\n" @@ -16,198 +16,238 @@ msgstr "" "Generated-By: pygettext.py 1.5\n" "X-Generator: Poedit 3.5\n" -#: src/rougail/output_doc/__init__.py:40 -msgid "the domain name can starts by a dot" -msgstr "le nom de domaine peut commencé par un point" - -#: src/rougail/output_doc/__init__.py:41 -msgid "the domain name can be a hostname" -msgstr "le nom de domaine peut être un nom d'hôte" - -#: src/rougail/output_doc/__init__.py:42 -msgid "the domain name can be an IP" -msgstr "le nom de domaine peut être une IP" - -#: src/rougail/output_doc/__init__.py:43 -msgid "the domain name can be network in CIDR format" -msgstr "le nom de domaine peut être un réseau au format CIDR" - -#: src/rougail/output_doc/__init__.py:48 -msgid "the minimum value is {0}" -msgstr "le valeur minimal est {0}" - -#: src/rougail/output_doc/__init__.py:49 -msgid "the maximum value is {0}" -msgstr "le valeur maximal est {0}" - -#: src/rougail/output_doc/__init__.py:55 -msgid "IP must be in CIDR format" -msgstr "IP doit être au format CIDR" - -#: src/rougail/output_doc/__init__.py:56 -msgid "private IP are allowed" -msgstr "les IP privées sont autorisés" - -#: src/rougail/output_doc/__init__.py:57 -msgid "reserved IP are allowed" -msgstr "les IP réservés sont autorisés" - -#: src/rougail/output_doc/__init__.py:62 -msgid "the host name can be an IP" -msgstr "le nom d'hôte peut être une IP" - -#: src/rougail/output_doc/__init__.py:67 -msgid "the domain name in web address can be an IP" -msgstr "le nom de domaine dans l'adresse web peut être une IP" - -#: src/rougail/output_doc/__init__.py:68 -msgid "the domain name in web address can be only a hostname" -msgstr "le nom de domaine dans l'adresse web ne peut être qu'un nom d'hôte" - -#: src/rougail/output_doc/__init__.py:75 -msgid "can be range of port" -msgstr "peut être un range de port" - -#: src/rougail/output_doc/__init__.py:76 -msgid "can have the protocol" -msgstr "peut avoir un protocole" - -#: src/rougail/output_doc/__init__.py:77 -msgid "port 0 is allowed" -msgstr "le port 0 est autorisé" - -#: src/rougail/output_doc/__init__.py:78 -msgid "ports 1 to 1023 are allowed" -msgstr "les ports entre 1 et 1023 sont autorisés" - -#: src/rougail/output_doc/__init__.py:79 -msgid "ports 1024 to 49151 are allowed" -msgstr "les ports entre 1024 et 49151 sont autorisés" - -#: src/rougail/output_doc/__init__.py:80 -msgid "ports greater than 49152 are allowed" -msgstr "les ports supérieurs à 49152 sont autorisés" - -#: src/rougail/output_doc/__init__.py:85 -msgid "minimum length for the secret" -msgstr "longueur minimum pour un secret" - -#: src/rougail/output_doc/__init__.py:86 -msgid "maximum length for the secret" -msgstr "longueur maximal pour un secret" - -#: src/rougail/output_doc/__init__.py:131 -msgid "mandatory" -msgstr "obligatoire" - -#: src/rougail/output_doc/__init__.py:132 -msgid "hidden" -msgstr "cachée" - -#: src/rougail/output_doc/__init__.py:133 -msgid "disabled" -msgstr "désactivé" - -#: src/rougail/output_doc/__init__.py:134 -msgid "unique" -msgstr "unique" - -#: src/rougail/output_doc/__init__.py:135 -msgid "auto modified" -msgstr "auto modifiée" - -#: src/rougail/output_doc/__init__.py:169 -msgid "Variables for \"{0}\"" -msgstr "Variables pour \"{0}\"" - -#: src/rougail/output_doc/__init__.py:186 -msgid "Variables" -msgstr "Variables" - -#: src/rougail/output_doc/__init__.py:193 -msgid "Example with mandatory variables not filled in" -msgstr "Exemple avec des variables obligatoire non renseignée" - -#: src/rougail/output_doc/__init__.py:499 -msgid "(default)" -msgstr "(defaut)" - -#: src/rougail/output_doc/__init__.py:504 -msgid "Choices" -msgstr "Choix" - -#: src/rougail/output_doc/__init__.py:507 -msgid "Default" -msgstr "Défaut" - -#: src/rougail/output_doc/__init__.py:563 -msgid "depends on a calculation" -msgstr "dépend d'un calcul" - -#: src/rougail/output_doc/__init__.py:564 -msgid "\"{0}\" is a calculation for {1} but has no description in {2}" -msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}" - -#: src/rougail/output_doc/__init__.py:570 -msgid "the value of the variable \"{0}\"" -msgstr "la valeur de la variable \"{0}\"" - -#: src/rougail/output_doc/__init__.py:575 -msgid "the value of the identifier" -msgstr "la valeur de l'identifiant" - -#: src/rougail/output_doc/__init__.py:579 -msgid "the value of the {0}" -msgstr "la valeur de l'{0}" - -#: src/rougail/output_doc/__init__.py:624 -msgid "Validator" -msgstr "Validateur" - -#: src/rougail/output_doc/__init__.py:624 -#: src/rougail/output_doc/__init__.py:627 -#, fuzzy -#| msgid ":" -msgid ": " -msgstr " : " - -#: src/rougail/output_doc/__init__.py:627 -msgid "Validators" -msgstr "Validateurs" - -#: src/rougail/output_doc/__init__.py:654 -#: src/rougail/output_doc/__init__.py:667 -msgid "Example" -msgstr "Exemple" - -#: src/rougail/output_doc/__init__.py:665 -msgid "Examples" -msgstr "Exemples" - -#: src/rougail/output_doc/annotator.py:220 -msgid "when the variable \"{0}\" has the value \"{1}\"" -msgstr "lorsque la variable \"{0}\" a la valeur \"{1}\"" - -#: src/rougail/output_doc/annotator.py:222 +#: src/rougail/output_doc/annotator.py:284 msgid "when the variable \"{0}\" hasn't the value \"{1}\"" msgstr "lorsque la variable \"{0}\" n'a pas la valeur \"{1}\"" -#: src/rougail/output_doc/annotator.py:224 -msgid "when the variable \"{0}\" has the value \"True\"" -msgstr "lorsque la variable \"{0}\" a la valeur \"True\"" +#: src/rougail/output_doc/annotator.py:290 +msgid "when the variable \"{0}\" has the value \"{1}\"" +msgstr "lorsque la variable \"{0}\" a la valeur \"{1}\"" -#: src/rougail/output_doc/annotator.py:231 +#: src/rougail/output_doc/annotator.py:306 msgid "the value of the information \"{0}\" of the variable \"{1}\"" msgstr "la valeur de l'information \"{0}\" de la variable \"{1}\"" -#: src/rougail/output_doc/annotator.py:233 +#: src/rougail/output_doc/annotator.py:309 msgid "the value of the global information \"{0}\"" msgstr "la valeur de l'information globale \"{0}\"" -#: src/rougail/output_doc/annotator.py:237 +#: src/rougail/output_doc/annotator.py:318 msgid "when the identifier is \"{0}\"" msgstr "lorsque l'identifiant est \"{0}\"" -#: src/rougail/output_doc/annotator.py:240 +#: src/rougail/output_doc/annotator.py:320 msgid "when the identifier is not \"{0}\"" msgstr "lorsque l'identifiant n'est pas \"{0}\"" + +#: src/rougail/output_doc/config.py:42 +msgid "duplicated level rougail-doc for output \"{0}\": {1} and {2}" +msgstr "niveau dupliqué pour rougail-doc pour la sortie \"{0}\": {1} et {2}" + +#: src/rougail/output_doc/doc.py:83 +msgid "mandatory" +msgstr "obligatoire" + +#: src/rougail/output_doc/doc.py:84 +msgid "hidden" +msgstr "cachée" + +#: src/rougail/output_doc/doc.py:85 +msgid "disabled" +msgstr "désactivé" + +#: src/rougail/output_doc/doc.py:86 +msgid "unique" +msgstr "unique" + +#: src/rougail/output_doc/doc.py:87 +msgid "auto modified" +msgstr "auto modifiée" + +#: src/rougail/output_doc/doc.py:264 +msgid "This family contains lists of variable blocks." +msgstr "Cette famille contient des listes de bloc de variable." + +#: src/rougail/output_doc/doc.py:272 +msgid "This family builds families dynamically." +msgstr "Cette famille construit des familles dynamiquement." + +#: src/rougail/output_doc/doc.py:302 +msgid "multiple" +msgstr "multiple" + +#: src/rougail/output_doc/doc.py:322 +msgid "No attribute \"description\" for \"{0}\" in {1}" +msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}" + +#: src/rougail/output_doc/doc.py:420 +msgid "(default)" +msgstr "(défaut)" + +#: src/rougail/output_doc/doc.py:427 +msgid "text based with regular expressions \"{0}\"" +msgstr "texte avec expression rationnelle \"{0}\"" + +#: src/rougail/output_doc/doc.py:514 +msgid "depends on a calculation" +msgstr "dépend d'un calcul" + +#: src/rougail/output_doc/doc.py:515 +msgid "\"{0}\" is a calculation for {1} but has no description in {2}" +msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}" + +#: src/rougail/output_doc/doc.py:539 +msgid "the value of the variable \"{0}\"" +msgstr "la valeur de la variable \"{0}\"" + +#: src/rougail/output_doc/doc.py:549 +msgid "the value of the identifier" +msgstr "la valeur de l'identifiant" + +#: src/rougail/output_doc/doc.py:553 +msgid "the value of the {0}" +msgstr "la valeur de l'{0}" + +#: src/rougail/output_doc/example.py:38 +msgid "Example with mandatory variables not filled in" +msgstr "Exemple avec des variables obligatoire non renseignée" + +#: src/rougail/output_doc/example.py:43 +msgid "Example with all variables modifiable" +msgstr "Exemple avec toutes les variables modifiable" + +#: src/rougail/output_doc/utils.py:41 +msgid "the domain name can starts by a dot" +msgstr "le nom de domaine peut commencé par un point" + +#: src/rougail/output_doc/utils.py:42 +msgid "the domain name can be a hostname" +msgstr "le nom de domaine peut être un nom d'hôte" + +#: src/rougail/output_doc/utils.py:43 +msgid "the domain name can be an IP" +msgstr "le nom de domaine peut être une IP" + +#: src/rougail/output_doc/utils.py:44 +msgid "the domain name can be network in CIDR format" +msgstr "le nom de domaine peut être un réseau au format CIDR" + +#: src/rougail/output_doc/utils.py:49 +msgid "the minimum value is {0}" +msgstr "le valeur minimal est {0}" + +#: src/rougail/output_doc/utils.py:50 +msgid "the maximum value is {0}" +msgstr "le valeur maximal est {0}" + +#: src/rougail/output_doc/utils.py:56 +msgid "IP must be in CIDR format" +msgstr "IP doit être au format CIDR" + +#: src/rougail/output_doc/utils.py:57 +msgid "private IP are allowed" +msgstr "les IP privées sont autorisés" + +#: src/rougail/output_doc/utils.py:58 +msgid "reserved IP are allowed" +msgstr "les IP réservés sont autorisés" + +#: src/rougail/output_doc/utils.py:63 +msgid "the host name can be an IP" +msgstr "le nom d'hôte peut être une IP" + +#: src/rougail/output_doc/utils.py:68 +msgid "the domain name in web address can be an IP" +msgstr "le nom de domaine dans l'adresse web peut être une IP" + +#: src/rougail/output_doc/utils.py:69 +msgid "the domain name in web address can be only a hostname" +msgstr "le nom de domaine dans l'adresse web ne peut être qu'un nom d'hôte" + +#: src/rougail/output_doc/utils.py:76 +msgid "can be range of port" +msgstr "peut être un range de port" + +#: src/rougail/output_doc/utils.py:77 +msgid "can have the protocol" +msgstr "peut avoir un protocole" + +#: src/rougail/output_doc/utils.py:78 +msgid "port 0 is allowed" +msgstr "le port 0 est autorisé" + +#: src/rougail/output_doc/utils.py:79 +msgid "ports 1 to 1023 are allowed" +msgstr "les ports entre 1 et 1023 sont autorisés" + +#: src/rougail/output_doc/utils.py:80 +msgid "ports 1024 to 49151 are allowed" +msgstr "les ports entre 1024 et 49151 sont autorisés" + +#: src/rougail/output_doc/utils.py:81 +msgid "ports greater than 49152 are allowed" +msgstr "les ports supérieurs à 49152 sont autorisés" + +#: src/rougail/output_doc/utils.py:86 +msgid "minimum length for the secret" +msgstr "longueur minimum pour un secret" + +#: src/rougail/output_doc/utils.py:87 +msgid "maximum length for the secret" +msgstr "longueur maximal pour un secret" + +#: src/rougail/output_doc/utils.py:215 +msgid "Variables" +msgstr "Variables" + +#: src/rougail/output_doc/utils.py:232 +msgid "Variables for \"{0}\"" +msgstr "Variables pour \"{0}\"" + +#: src/rougail/output_doc/utils.py:247 +msgid "Identifiers" +msgstr "Identifiants" + +#: src/rougail/output_doc/utils.py:296 +msgid "Validator" +msgstr "Validateur" + +#: src/rougail/output_doc/utils.py:298 +msgid "Validators" +msgstr "Validateurs" + +#: src/rougail/output_doc/utils.py:300 +msgid "Choices" +msgstr "Choix" + +#: src/rougail/output_doc/utils.py:302 +msgid "Default" +msgstr "Défaut" + +#: src/rougail/output_doc/utils.py:306 +msgid "Example" +msgstr "Exemple" + +#: src/rougail/output_doc/utils.py:308 +msgid "Examples" +msgstr "Exemples" + +#: src/rougail/output_doc/utils.py:346 +msgid "Description" +msgstr "Description" + +#: src/rougail/output_doc/utils.py:346 +msgid "Variable" +msgstr "Variable" + +#: src/rougail/output_doc/utils.py:367 +msgid "{0}: {1}" +msgstr "{0} : {1}" + +#, fuzzy +#~| msgid ":" +#~ msgid ": " +#~ msgstr " : " + +#~ msgid "when the variable \"{0}\" has the value \"True\"" +#~ msgstr "lorsque la variable \"{0}\" a la valeur \"True\"" diff --git a/locale/rougail_output_doc.pot b/locale/rougail_output_doc.pot index bf4c4cf..4d20457 100644 --- a/locale/rougail_output_doc.pot +++ b/locale/rougail_output_doc.pot @@ -5,7 +5,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"POT-Creation-Date: 2024-11-07 22:47+0100\n" +"POT-Creation-Date: 2024-11-20 21:09+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -15,197 +15,231 @@ msgstr "" "Generated-By: pygettext.py 1.5\n" -#: src/rougail/output_doc/__init__.py:40 -msgid "the domain name can starts by a dot" -msgstr "" - -#: src/rougail/output_doc/__init__.py:41 -msgid "the domain name can be a hostname" -msgstr "" - -#: src/rougail/output_doc/__init__.py:42 -msgid "the domain name can be an IP" -msgstr "" - -#: src/rougail/output_doc/__init__.py:43 -msgid "the domain name can be network in CIDR format" -msgstr "" - -#: src/rougail/output_doc/__init__.py:48 -msgid "the minimum value is {0}" -msgstr "" - -#: src/rougail/output_doc/__init__.py:49 -msgid "the maximum value is {0}" -msgstr "" - -#: src/rougail/output_doc/__init__.py:55 -msgid "IP must be in CIDR format" -msgstr "" - -#: src/rougail/output_doc/__init__.py:56 -msgid "private IP are allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:57 -msgid "reserved IP are allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:62 -msgid "the host name can be an IP" -msgstr "" - -#: src/rougail/output_doc/__init__.py:67 -msgid "the domain name in web address can be an IP" -msgstr "" - -#: src/rougail/output_doc/__init__.py:68 -msgid "the domain name in web address can be only a hostname" -msgstr "" - -#: src/rougail/output_doc/__init__.py:75 -msgid "can be range of port" -msgstr "" - -#: src/rougail/output_doc/__init__.py:76 -msgid "can have the protocol" -msgstr "" - -#: src/rougail/output_doc/__init__.py:77 -msgid "port 0 is allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:78 -msgid "ports 1 to 1023 are allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:79 -msgid "ports 1024 to 49151 are allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:80 -msgid "ports greater than 49152 are allowed" -msgstr "" - -#: src/rougail/output_doc/__init__.py:85 -msgid "minimum length for the secret" -msgstr "" - -#: src/rougail/output_doc/__init__.py:86 -msgid "maximum length for the secret" -msgstr "" - -#: src/rougail/output_doc/__init__.py:131 -msgid "mandatory" -msgstr "" - -#: src/rougail/output_doc/__init__.py:132 -msgid "hidden" -msgstr "" - -#: src/rougail/output_doc/__init__.py:133 -msgid "disabled" -msgstr "" - -#: src/rougail/output_doc/__init__.py:134 -msgid "unique" -msgstr "" - -#: src/rougail/output_doc/__init__.py:135 -msgid "auto modified" -msgstr "" - -#: src/rougail/output_doc/__init__.py:169 -msgid "Variables for \"{0}\"" -msgstr "" - -#: src/rougail/output_doc/__init__.py:186 -msgid "Variables" -msgstr "" - -#: src/rougail/output_doc/__init__.py:193 -msgid "Example with mandatory variables not filled in" -msgstr "" - -#: src/rougail/output_doc/__init__.py:499 -msgid "(default)" -msgstr "" - -#: src/rougail/output_doc/__init__.py:504 -msgid "Choices" -msgstr "" - -#: src/rougail/output_doc/__init__.py:507 -msgid "Default" -msgstr "" - -#: src/rougail/output_doc/__init__.py:563 -msgid "depends on a calculation" -msgstr "" - -#: src/rougail/output_doc/__init__.py:564 -msgid "\"{0}\" is a calculation for {1} but has no description in {2}" -msgstr "" - -#: src/rougail/output_doc/__init__.py:570 -msgid "the value of the variable \"{0}\"" -msgstr "" - -#: src/rougail/output_doc/__init__.py:575 -msgid "the value of the identifier" -msgstr "" - -#: src/rougail/output_doc/__init__.py:579 -msgid "the value of the {0}" -msgstr "" - -#: src/rougail/output_doc/__init__.py:624 -msgid "Validator" -msgstr "" - -#: src/rougail/output_doc/__init__.py:624 -#: src/rougail/output_doc/__init__.py:627 -msgid ": " -msgstr "" - -#: src/rougail/output_doc/__init__.py:627 -msgid "Validators" -msgstr "" - -#: src/rougail/output_doc/__init__.py:654 -#: src/rougail/output_doc/__init__.py:667 -msgid "Example" -msgstr "" - -#: src/rougail/output_doc/__init__.py:665 -msgid "Examples" -msgstr "" - -#: src/rougail/output_doc/annotator.py:220 -msgid "when the variable \"{0}\" has the value \"{1}\"" -msgstr "" - -#: src/rougail/output_doc/annotator.py:222 +#: src/rougail/output_doc/annotator.py:284 msgid "when the variable \"{0}\" hasn't the value \"{1}\"" msgstr "" -#: src/rougail/output_doc/annotator.py:224 -msgid "when the variable \"{0}\" has the value \"True\"" +#: src/rougail/output_doc/annotator.py:290 +msgid "when the variable \"{0}\" has the value \"{1}\"" msgstr "" -#: src/rougail/output_doc/annotator.py:238 +#: src/rougail/output_doc/annotator.py:306 msgid "the value of the information \"{0}\" of the variable \"{1}\"" msgstr "" -#: src/rougail/output_doc/annotator.py:240 +#: src/rougail/output_doc/annotator.py:309 msgid "the value of the global information \"{0}\"" msgstr "" -#: src/rougail/output_doc/annotator.py:244 +#: src/rougail/output_doc/annotator.py:318 msgid "when the identifier is \"{0}\"" msgstr "" -#: src/rougail/output_doc/annotator.py:247 +#: src/rougail/output_doc/annotator.py:320 msgid "when the identifier is not \"{0}\"" msgstr "" +#: src/rougail/output_doc/config.py:42 +msgid "duplicated level rougail-doc for output \"{0}\": {1} and {2}" +msgstr "" + +#: src/rougail/output_doc/doc.py:83 +msgid "mandatory" +msgstr "" + +#: src/rougail/output_doc/doc.py:84 +msgid "hidden" +msgstr "" + +#: src/rougail/output_doc/doc.py:85 +msgid "disabled" +msgstr "" + +#: src/rougail/output_doc/doc.py:86 +msgid "unique" +msgstr "" + +#: src/rougail/output_doc/doc.py:87 +msgid "auto modified" +msgstr "" + +#: src/rougail/output_doc/doc.py:264 +msgid "This family contains lists of variable blocks." +msgstr "" + +#: src/rougail/output_doc/doc.py:272 +msgid "This family builds families dynamically." +msgstr "" + +#: src/rougail/output_doc/doc.py:302 +msgid "multiple" +msgstr "" + +#: src/rougail/output_doc/doc.py:322 +msgid "No attribute \"description\" for \"{0}\" in {1}" +msgstr "" + +#: src/rougail/output_doc/doc.py:420 +msgid "(default)" +msgstr "" + +#: src/rougail/output_doc/doc.py:427 +msgid "text based with regular expressions \"{0}\"" +msgstr "" + +#: src/rougail/output_doc/doc.py:514 +msgid "depends on a calculation" +msgstr "" + +#: src/rougail/output_doc/doc.py:515 +msgid "\"{0}\" is a calculation for {1} but has no description in {2}" +msgstr "" + +#: src/rougail/output_doc/doc.py:539 +msgid "the value of the variable \"{0}\"" +msgstr "" + +#: src/rougail/output_doc/doc.py:549 +msgid "the value of the identifier" +msgstr "" + +#: src/rougail/output_doc/doc.py:553 +msgid "the value of the {0}" +msgstr "" + +#: src/rougail/output_doc/example.py:38 +msgid "Example with mandatory variables not filled in" +msgstr "" + +#: src/rougail/output_doc/example.py:43 +msgid "Example with all variables modifiable" +msgstr "" + +#: src/rougail/output_doc/utils.py:41 +msgid "the domain name can starts by a dot" +msgstr "" + +#: src/rougail/output_doc/utils.py:42 +msgid "the domain name can be a hostname" +msgstr "" + +#: src/rougail/output_doc/utils.py:43 +msgid "the domain name can be an IP" +msgstr "" + +#: src/rougail/output_doc/utils.py:44 +msgid "the domain name can be network in CIDR format" +msgstr "" + +#: src/rougail/output_doc/utils.py:49 +msgid "the minimum value is {0}" +msgstr "" + +#: src/rougail/output_doc/utils.py:50 +msgid "the maximum value is {0}" +msgstr "" + +#: src/rougail/output_doc/utils.py:56 +msgid "IP must be in CIDR format" +msgstr "" + +#: src/rougail/output_doc/utils.py:57 +msgid "private IP are allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:58 +msgid "reserved IP are allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:63 +msgid "the host name can be an IP" +msgstr "" + +#: src/rougail/output_doc/utils.py:68 +msgid "the domain name in web address can be an IP" +msgstr "" + +#: src/rougail/output_doc/utils.py:69 +msgid "the domain name in web address can be only a hostname" +msgstr "" + +#: src/rougail/output_doc/utils.py:76 +msgid "can be range of port" +msgstr "" + +#: src/rougail/output_doc/utils.py:77 +msgid "can have the protocol" +msgstr "" + +#: src/rougail/output_doc/utils.py:78 +msgid "port 0 is allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:79 +msgid "ports 1 to 1023 are allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:80 +msgid "ports 1024 to 49151 are allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:81 +msgid "ports greater than 49152 are allowed" +msgstr "" + +#: src/rougail/output_doc/utils.py:86 +msgid "minimum length for the secret" +msgstr "" + +#: src/rougail/output_doc/utils.py:87 +msgid "maximum length for the secret" +msgstr "" + +#: src/rougail/output_doc/utils.py:215 +msgid "Variables" +msgstr "" + +#: src/rougail/output_doc/utils.py:232 +msgid "Variables for \"{0}\"" +msgstr "" + +#: src/rougail/output_doc/utils.py:247 +msgid "Identifiers" +msgstr "" + +#: src/rougail/output_doc/utils.py:296 +msgid "Validator" +msgstr "" + +#: src/rougail/output_doc/utils.py:298 +msgid "Validators" +msgstr "" + +#: src/rougail/output_doc/utils.py:300 +msgid "Choices" +msgstr "" + +#: src/rougail/output_doc/utils.py:302 +msgid "Default" +msgstr "" + +#: src/rougail/output_doc/utils.py:306 +msgid "Example" +msgstr "" + +#: src/rougail/output_doc/utils.py:308 +msgid "Examples" +msgstr "" + +#: src/rougail/output_doc/utils.py:346 +msgid "Description" +msgstr "" + +#: src/rougail/output_doc/utils.py:346 +msgid "Variable" +msgstr "" + +#: src/rougail/output_doc/utils.py:367 +msgid "{0}: {1}" +msgstr "" + diff --git a/pyproject.toml b/pyproject.toml index e425b81..751489b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,6 +27,7 @@ classifiers = [ dependencies = [ "rougail ~= 1.2,<2", "tabulate ~= 0.9.0", + "rich ~= 13.9.3", ] [project.urls] diff --git a/src/rougail/output_doc/__init__.py b/src/rougail/output_doc/__init__.py index 9fa2e9c..907650d 100644 --- a/src/rougail/output_doc/__init__.py +++ b/src/rougail/output_doc/__init__.py @@ -15,6 +15,7 @@ details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . """ + from .doc import RougailOutputDoc diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py index a6b5398..5aeb97f 100644 --- a/src/rougail/output_doc/annotator.py +++ b/src/rougail/output_doc/annotator.py @@ -222,36 +222,41 @@ class Annotator(Walk): version: str, ): if not isinstance(values, Calculation): - return {'value': values} + return {"value": values} if isinstance(values, JinjaCalculation): - return {"type": "jinja", - "value": self._calculation_to_information_jinja(values), - } + return { + "type": "jinja", + "value": self._calculation_to_information_jinja(values), + } if isinstance(values, (VariableCalculation, VariablePropertyCalculation)): value = self._calculation_to_information_variable( values, prop, version, path ) if value is None: return - return {"type": "variable", - "value": value, - } + return { + "type": "variable", + "value": value, + } if isinstance(values, InformationCalculation): - return {"type": "information", - "value": self._calculation_to_information_information( - values, version, path - ), - } + return { + "type": "information", + "value": self._calculation_to_information_information( + values, version, path + ), + } if isinstance(values, (IdentifierCalculation, IdentifierPropertyCalculation)): - return {"type": "identifier", - "value": self._calculation_to_information_identifier( - values, prop, version - ), - } + return { + "type": "identifier", + "value": self._calculation_to_information_identifier( + values, prop, version + ), + } if isinstance(values, IndexCalculation): - return {"type": "index", - "value": True, - } + return { + "type": "index", + "value": True, + } raise Exception('unknown calculation "{values}"') def _calculation_to_information_jinja(self, values): @@ -306,9 +311,7 @@ class Annotator(Walk): return _('the value of the information "{0}" of the variable "{1}"').format( values.information, variable_path ) - return _('the value of the global information "{0}"').format( - values.information - ) + return _('the value of the global information "{0}"').format(values.information) def _calculation_to_information_identifier( self, values, prop: str, version: str diff --git a/src/rougail/output_doc/doc.py b/src/rougail/output_doc/doc.py index 7ffd7ed..05bb85a 100644 --- a/src/rougail/output_doc/doc.py +++ b/src/rougail/output_doc/doc.py @@ -122,7 +122,9 @@ class RougailOutputDoc(Examples): return if path not in self.dynamic_paths: self.dynamic_paths[path] = {"paths": [], "names": []} - self.dynamic_paths[path]["paths"].append(self._dyn_path_to_italic(variable, path)) + self.dynamic_paths[path]["paths"].append( + self._dyn_path_to_italic(variable, path) + ) self.dynamic_paths[path]["names"].append(variable.name()) def _populate_dynamic_family(self, family, path) -> None: @@ -178,7 +180,9 @@ class RougailOutputDoc(Examples): ) -> Optional[dict]: if variable.isdynamic(): # information is already set - potential_leader = self._parse_variable_dynamic(variable, leader, name, path, informations) + potential_leader = self._parse_variable_dynamic( + variable, leader, name, path, informations + ) elif variable.isfollower() and variable.index(): potential_leader = self._parse_variable_follower_with_index( variable, name, informations @@ -219,7 +223,9 @@ class RougailOutputDoc(Examples): ) return None - def _parse_variable_dynamic(self, variable, leader, name, path, informations) -> None: + def _parse_variable_dynamic( + self, variable, leader, name, path, informations + ) -> None: dynamic_variable = self.dynamic_paths[path] if "type" in dynamic_variable: if self.with_example: @@ -301,7 +307,7 @@ class RougailOutputDoc(Examples): "type": "multiple", "name": _("multiple"), } - ) + ) informations["multiple"] = True examples = variable.information.get("examples", None) if examples is None: @@ -318,7 +324,9 @@ class RougailOutputDoc(Examples): informations["paths"] = [obj.path(uncalculated=True)] informations["names"] = [obj.name()] description = obj.description(uncalculated=True) - if obj.name(uncalculated=True) == description: + if obj.name(uncalculated=True) == description and ( + not obj.isoptiondescription() or obj.group_type() is not groups.namespace + ): warning = _('No attribute "description" for "{0}" in {1}').format( informations["paths"][0], display_xmlfiles(obj.information.get("dictionaries")), @@ -482,10 +490,8 @@ class RougailOutputDoc(Examples): do_not_raise=False, ): if identifier: - raise Exception('pfff') - calculation = variable.information.get( - f"{prop}_calculation", None - ) + raise Exception("pfff") + calculation = variable.information.get(f"{prop}_calculation", None) if not calculation: if do_not_raise: return None @@ -493,8 +499,8 @@ class RougailOutputDoc(Examples): f'cannot find "{prop}_calculation" information, ' "do you have declare doc has a plugins?" ) -# if do_not_raise and calculation.get('optional', False): -# return None + # if do_not_raise and calculation.get('optional', False): + # return None if isinstance(calculation, list): values = [] for cal in calculation: @@ -524,7 +530,7 @@ class RougailOutputDoc(Examples): if prop in PROPERTY_ATTRIBUTE: values = calculation["value"] else: - if calculation.get('optional', False): + if calculation.get("optional", False): # FIXME pas forcement dans self.dynamic_paths encore ... path = calculation["value"] if "{{ identifier }}" in path: @@ -539,7 +545,10 @@ class RougailOutputDoc(Examples): msg = _('the value of the variable "{0}"') if "{{ identifier }}" in calculation["value"]: # FIXME pas forcement dans self.dynamic_paths encore ... - values = [msg.format(path) for path in self.dynamic_paths[calculation["value"]]["paths"]] + values = [ + msg.format(path) + for path in self.dynamic_paths[calculation["value"]]["paths"] + ] else: values = msg.format(calculation["value"]) elif calculation["type"] == "identifier": diff --git a/src/rougail/output_doc/example.py b/src/rougail/output_doc/example.py index f5c32d2..eb6537b 100644 --- a/src/rougail/output_doc/example.py +++ b/src/rougail/output_doc/example.py @@ -23,6 +23,7 @@ from .utils import _ class Examples: # pylint: disable=no-member,too-few-public-methods """Build examples""" + def __init__(self): self.examples = None self.examples_mandatories = None diff --git a/src/rougail/output_doc/locale/fr/LC_MESSAGES/rougail_output_doc.mo b/src/rougail/output_doc/locale/fr/LC_MESSAGES/rougail_output_doc.mo index aa63d67..f8e825d 100644 Binary files a/src/rougail/output_doc/locale/fr/LC_MESSAGES/rougail_output_doc.mo and b/src/rougail/output_doc/locale/fr/LC_MESSAGES/rougail_output_doc.mo differ diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py index 8b2e967..a4798aa 100644 --- a/src/rougail/output_doc/output/asciidoc.py +++ b/src/rougail/output_doc/output/asciidoc.py @@ -22,7 +22,9 @@ from ..utils import CommonFormater, dump class Formater(CommonFormater): """The asciidoc formater""" + name = "asciidoc" + _table_name = "asciidoc" level = 40 def header(self): diff --git a/src/rougail/output_doc/output/console.py b/src/rougail/output_doc/output/console.py new file mode 100644 index 0000000..46fbf6e --- /dev/null +++ b/src/rougail/output_doc/output/console.py @@ -0,0 +1,60 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from .github import Formater as GFormater + + +# from rich.text import Text +# from rich.table import Table, Column +# from rich.console import Console +# +# from typing import List +# from ..utils import CommonFormater, dump +# +## console.print(table) +# +class Formater(GFormater): + """The console formater""" + + name = "console" + level = 10 + enter_table = "\n" + + def header(self): + """Header of the documentation""" + return "" + + def run(self, dico: dict, level: int) -> str: + msg = super().run(dico, level) + from rich.console import Console + from rich.markdown import Markdown + + console = Console() + + markdown = Markdown(msg) + with console.capture() as capture: + console.print(markdown) + return capture.get() + + def link( + self, + comment: str, + link: str, + ) -> str: + """Add a link""" + return self.prop(comment, False) diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py index 652e7c8..672ccca 100644 --- a/src/rougail/output_doc/output/github.py +++ b/src/rougail/output_doc/output/github.py @@ -23,7 +23,9 @@ from ..utils import dump, CommonFormater class Formater(CommonFormater): """The markdown (for github) formater""" + name = "github" + _table_name = "github" level = 50 enter_table = "
" diff --git a/src/rougail/output_doc/output/ojson.py b/src/rougail/output_doc/output/ojson.py index e13f84a..349e2ce 100644 --- a/src/rougail/output_doc/output/ojson.py +++ b/src/rougail/output_doc/output/ojson.py @@ -22,6 +22,7 @@ from typing import Any class Formater: """Just return internal structure to json""" + name = "json" level = 90 diff --git a/src/rougail/output_doc/utils.py b/src/rougail/output_doc/utils.py index 18771fa..fa6c7e8 100644 --- a/src/rougail/output_doc/utils.py +++ b/src/rougail/output_doc/utils.py @@ -315,7 +315,7 @@ class CommonFormater: """Transform properties to string""" properties = [] for prop in dico.get("properties", []): - if prop["type"] == 'type': + if prop["type"] == "type": properties.append(self.link(prop["name"], ROUGAIL_VARIABLE_TYPE)) else: if "annotation" in prop: @@ -343,8 +343,8 @@ class CommonFormater: msg = ( tabulate( datas, - headers=self.table_header(["Variable", "Description"]), - tablefmt=self.name, + headers=self.table_header([_("Variable"), _("Description")]), + tablefmt=self._table_name, ) + "\n\n" ) diff --git a/tests/docs/base/00_0empty.sh b/tests/docs/base/00_0empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/00_0version_underscore.sh b/tests/docs/base/00_0version_underscore.sh new file mode 100644 index 0000000..0c4d4fd --- /dev/null +++ b/tests/docs/base/00_0version_underscore.sh @@ -0,0 +1,18 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +_version: '1.1' +version: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.version + string basic mandatory A variable. + diff --git a/tests/docs/base/00_1empty_variable.sh b/tests/docs/base/00_1empty_variable.sh new file mode 100644 index 0000000..edbc571 --- /dev/null +++ b/tests/docs/base/00_1empty_variable.sh @@ -0,0 +1,18 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +empty: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.empty + string basic mandatory Empty. + diff --git a/tests/docs/base/00_2default_calculated.sh b/tests/docs/base/00_2default_calculated.sh new file mode 100644 index 0000000..fc4ac1f --- /dev/null +++ b/tests/docs/base/00_2default_calculated.sh @@ -0,0 +1,32 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + multi: true + default: + jinja: | + {{ _.var1 }} + description: the value of var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string standard mandatory unique multiple A second variable. + Default: the value of var1. + diff --git a/tests/docs/base/00_2default_calculated_multi.sh b/tests/docs/base/00_2default_calculated_multi.sh new file mode 100644 index 0000000..2cb6d75 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_multi.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: # a first variable + - no + - yes + - maybe +var2: + description: a second variable + multi: true + default: + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A first variable. + Default: + + + • no + • yes + • maybe + | | rougail.var2 string standard mandatory unique multiple + | A second variable. Default: the value of _.var1. + | diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.sh b/tests/docs/base/00_2default_calculated_variable_transitive.sh new file mode 100644 index 0000000..1e61647 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_variable_transitive.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                                   Description                                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + domainname basic mandatory unique multiple A first variable. + Validator: the domain name can be an IP + rougail.var2 + domainname standard mandatory unique multiple A second variable. + Validator: the domain name can be an IP + Default: the value of the variable "rougail.var1". + diff --git a/tests/docs/base/00_4load_subfolder.sh b/tests/docs/base/00_4load_subfolder.sh new file mode 100644 index 0000000..e137f74 --- /dev/null +++ b/tests/docs/base/00_4load_subfolder.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/99-base.yml + +```yaml +--- +version: '1.0' +var1: + description: a variable +``` +# dictionaries/rougail2/00-base.yml + +```yaml +--- +version: '1.0' +var2: + description: a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A variable. + rougail.var2 + string basic mandatory A variable. + diff --git a/tests/docs/base/00_5load_notype.sh b/tests/docs/base/00_5load_notype.sh new file mode 100644 index 0000000..cb7527a --- /dev/null +++ b/tests/docs/base/00_5load_notype.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +without_type: + description: a variable + default: non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.without_type + string standard mandatory A variable. + Default: non + diff --git a/tests/docs/base/00_6boolean.sh b/tests/docs/base/00_6boolean.sh new file mode 100644 index 0000000..8f5cab8 --- /dev/null +++ b/tests/docs/base/00_6boolean.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + boolean standard mandatory The first variable. + Default: true + rougail.var2 + boolean standard mandatory The second variable. + Default: true + rougail.var3 + boolean standard mandatory The third variable. + Default: true + rougail.var4 + boolean standard mandatory The forth variable. + Default: false + rougail.var5 + boolean standard mandatory The fifth variable. + Default: false + rougail.var6 + boolean standard mandatory The sixth variable. + Default: false + diff --git a/tests/docs/base/00_6boolean_no_mandatory.sh b/tests/docs/base/00_6boolean_no_mandatory.sh new file mode 100644 index 0000000..348407b --- /dev/null +++ b/tests/docs/base/00_6boolean_no_mandatory.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                Description            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + boolean standard A variable. + Default: true + diff --git a/tests/docs/base/00_6choice.sh b/tests/docs/base/00_6choice.sh new file mode 100644 index 0000000..140a31f --- /dev/null +++ b/tests/docs/base/00_6choice.sh @@ -0,0 +1,84 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + choice basic mandatory The first variable. + Choices: + + + • a + • b + • c | | rougail.var2 choice basic mandatory + | The second variable. Choices: + • a + • b + • c | | rougail.var3 choice standard + | The third variable. Choices: + • a + • b + • c + • null | | rougail.var4 choice standard + | The forth variable. Choices: + • null + • b + • c | | rougail.var5 choice standard mandatory + | The fifth variable. Choices: + • a ← (default) + • b + • c | | rougail.var6 choice standard mandatory + | The sixth variable. Choices: + • 1 ← (default) + • 2 + • 3 | diff --git a/tests/docs/base/00_6choice_calculation.sh b/tests/docs/base/00_6choice_calculation.sh new file mode 100644 index 0000000..1678175 --- /dev/null +++ b/tests/docs/base/00_6choice_calculation.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + default: 9 + choices: + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A variable. + Choices: choices is 0 to 9. + Default: 9 + diff --git a/tests/docs/base/00_6choice_variable.sh b/tests/docs/base/00_6choice_variable.sh new file mode 100644 index 0000000..ce3abb4 --- /dev/null +++ b/tests/docs/base/00_6choice_variable.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a second variable + - a + - b + - c +var2: + description: a first variable + default: a + choices: + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                                  Description                                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A second variable. + Default: + + + • a + • b + • c + | | rougail.var2 choice standard mandatory + | A first variable. Choices: the value of the variable "rougail.var1". Default: a + | diff --git a/tests/docs/base/00_6custom.sh b/tests/docs/base/00_6custom.sh new file mode 100644 index 0000000..1c5a8c6 --- /dev/null +++ b/tests/docs/base/00_6custom.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.custom1 + custom basic mandatory The first variable. + rougail.custom2 + custom standard mandatory The seconf variable. + Default: value + diff --git a/tests/docs/base/00_6domainname.sh b/tests/docs/base/00_6domainname.sh new file mode 100644 index 0000000..6eec885 --- /dev/null +++ b/tests/docs/base/00_6domainname.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + domainname standard mandatory A domain name variable. + Default: my.domain.name + diff --git a/tests/docs/base/00_6domainname_params.sh b/tests/docs/base/00_6domainname_params.sh new file mode 100644 index 0000000..798d601 --- /dev/null +++ b/tests/docs/base/00_6domainname_params.sh @@ -0,0 +1,27 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                       Description                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + domainname standard mandatory A domain name variable. + Validator: the domain name can be an IP + Default: my.domain.name + diff --git a/tests/docs/base/00_6float.sh b/tests/docs/base/00_6float.sh new file mode 100644 index 0000000..c17318a --- /dev/null +++ b/tests/docs/base/00_6float.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                          Description                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + float standard mandatory The first variable. + Default: 0.0 + rougail.var2 + float standard mandatory The second variable. + Default: 0.0 + rougail.var3 + float standard mandatory The third variable. + Default: 0.0 + rougail.var4 + float standard mandatory The forth variable. + Default: 10.1 + rougail.var5 + float standard mandatory The fifth variable. + Default: 10.1 + rougail.var6 + float standard mandatory The sixth variable. + Default: 10.1 + diff --git a/tests/docs/base/00_6number.sh b/tests/docs/base/00_6number.sh new file mode 100644 index 0000000..8e48378 --- /dev/null +++ b/tests/docs/base/00_6number.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + number standard mandatory The first variable. + Default: 0 + rougail.var2 + number standard mandatory The second variable. + Default: 0 + rougail.var3 + number standard mandatory The third variable. + Default: 0 + rougail.var4 + number standard mandatory This forth variable. + Default: 10 + rougail.var5 + number standard mandatory The fifth variable. + Default: 10 + rougail.var6 + number standard mandatory The sixth variable. + Default: 10 + diff --git a/tests/docs/base/00_6port.sh b/tests/docs/base/00_6port.sh new file mode 100644 index 0000000..bc8d349 --- /dev/null +++ b/tests/docs/base/00_6port.sh @@ -0,0 +1,38 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                       Description                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + port basic mandatory A port variable. + rougail.variable2 + port standard mandatory A port variable with default value. + Default: 8080 + rougail.variable3 + port standard mandatory A port variable with integer default value. + Default: 8080 + diff --git a/tests/docs/base/00_6regexp.sh b/tests/docs/base/00_6regexp.sh new file mode 100644 index 0000000..67d43c4 --- /dev/null +++ b/tests/docs/base/00_6regexp.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                        Description                                                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + regexp standard mandatory A first variable. + Validator: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" + Default: #a1a1a1 + Examples: + + + • #b1b1b1 + • #b2b2b2 + | diff --git a/tests/docs/base/00_6string.sh b/tests/docs/base/00_6string.sh new file mode 100644 index 0000000..985b411 --- /dev/null +++ b/tests/docs/base/00_6string.sh @@ -0,0 +1,53 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory The first variable. + rougail.var2 + string basic mandatory The second variable. + rougail.var3 + string basic mandatory The third variable. + rougail.var4 + string standard mandatory The forth variable. + Default: value + rougail.var5 + string standard mandatory The fifth variable. + Default: value + rougail.var6 + string standard mandatory The sixth variable. + Default: value + diff --git a/tests/docs/base/00_7choice_quote.sh b/tests/docs/base/00_7choice_quote.sh new file mode 100644 index 0000000..0b7a264 --- /dev/null +++ b/tests/docs/base/00_7choice_quote.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A choice. + Choices: + + + • quote' ← (default) + • quote" + • quote"' | diff --git a/tests/docs/base/00_7help_quote.sh b/tests/docs/base/00_7help_quote.sh new file mode 100644 index 0000000..df57f68 --- /dev/null +++ b/tests/docs/base/00_7help_quote.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory The first variable. + Message with '. + rougail.var2 + string basic mandatory The second variable. + Message with ". + diff --git a/tests/docs/base/00_7value_doublequote.sh b/tests/docs/base/00_7value_doublequote.sh new file mode 100644 index 0000000..43aae72 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote" + diff --git a/tests/docs/base/00_7value_doublequote2.sh b/tests/docs/base/00_7value_doublequote2.sh new file mode 100644 index 0000000..10f4c49 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote2.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote'" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote'" + diff --git a/tests/docs/base/00_7value_doublequote3.sh b/tests/docs/base/00_7value_doublequote3.sh new file mode 100644 index 0000000..a2bb063 --- /dev/null +++ b/tests/docs/base/00_7value_doublequote3.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: quote\"\' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote"' + diff --git a/tests/docs/base/00_7value_quote.sh b/tests/docs/base/00_7value_quote.sh new file mode 100644 index 0000000..b3e03a5 --- /dev/null +++ b/tests/docs/base/00_7value_quote.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + default: quote' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote' + diff --git a/tests/docs/base/00_8calculation_information.sh b/tests/docs/base/00_8calculation_information.sh new file mode 100644 index 0000000..0b8158d --- /dev/null +++ b/tests/docs/base/00_8calculation_information.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                          Description                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: get information test_information. + diff --git a/tests/docs/base/00_8test.sh b/tests/docs/base/00_8test.sh new file mode 100644 index 0000000..d837ed8 --- /dev/null +++ b/tests/docs/base/00_8test.sh @@ -0,0 +1,84 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: the first variable + test: + - test + +var2: + description: the second variable + test: + - test + default: value + +var3: + description: the third variable + test: + - test1 + - test2 + +var4: + description: the forth variable + test: + - + - test1 + - test2 + mandatory: false + +var5: + description: the fifth variable + type: boolean + test: + - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory The first variable. + Example: test + rougail.var2 + string standard mandatory The second variable. + Default: value + Example: test + rougail.var3 + string basic mandatory The third variable. + Examples: + + + • test1 + • test2 + | | rougail.var4 string standard + | The forth variable. Examples: + • null + • test1 + • test2 + | | rougail.var5 boolean standard mandatory + | The fifth variable. Default: true Example: false + | | rougail.var6 string basic mandatory unique multiple + | The sixth variable. Examples: + • test1 + • test2 + | diff --git a/tests/docs/base/00_9choice_variable_multi.sh b/tests/docs/base/00_9choice_variable_multi.sh new file mode 100644 index 0000000..508062e --- /dev/null +++ b/tests/docs/base/00_9choice_variable_multi.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + choice basic mandatory unique multiple A first variable. + Choices: + + + • val1 + • val2 + | | rougail.variable2 choice standard unique multiple + | A second variable. Choices: + • val1 + • val2 + | diff --git a/tests/docs/base/00_9choice_variables.sh b/tests/docs/base/00_9choice_variables.sh new file mode 100644 index 0000000..f82f4f3 --- /dev/null +++ b/tests/docs/base/00_9choice_variables.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +source_variable_1: val1 # the first source variable +source_variable_2: val2 # the second source variable +my_variable: + description: a variable + type: choice + choices: + - variable: _.source_variable_1 + - variable: _.source_variable_2 + default: val1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                    Description                                                + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.source_variable_1 + string standard mandatory The first source variable. + Default: val1 + rougail.source_variable_2 + string standard mandatory The second source variable. + Default: val2 + rougail.my_variable + choice standard mandatory A variable. + Choices: + + + • the value of the variable "rougail.source_variable_1". + • the value of the variable "rougail.source_variable_2". Default: val1 + | diff --git a/tests/docs/base/00_9default_calculation.sh b/tests/docs/base/00_9default_calculation.sh new file mode 100644 index 0000000..734568c --- /dev/null +++ b/tests/docs/base/00_9default_calculation.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: concat all parameters. + diff --git a/tests/docs/base/00_9default_calculation_information.sh b/tests/docs/base/00_9default_calculation_information.sh new file mode 100644 index 0000000..d64abd4 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A variable. + Default: returns the information. + diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.sh b/tests/docs/base/00_9default_calculation_information_other_variable.sh new file mode 100644 index 0000000..da07c05 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_information_other_variable.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                  Description                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A first variable. + rougail.var2 + string standard mandatory A second variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/00_9default_calculation_multi_optional.sh b/tests/docs/base/00_9default_calculation_multi_optional.sh new file mode 100644 index 0000000..e21af1d --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory My_variable. + Default: val1 + rougail.my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + Default: the value of the variable "rougail.my_variable". + diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.sh b/tests/docs/base/00_9default_calculation_multi_optional2.sh new file mode 100644 index 0000000..5a12610 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional2.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory My_variable. + Default: val1 + rougail.my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + Default: the value of the variable "rougail.my_variable". + diff --git a/tests/docs/base/00_9default_calculation_optional.sh b/tests/docs/base/00_9default_calculation_optional.sh new file mode 100644 index 0000000..6560e2a --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + diff --git a/tests/docs/base/00_9default_calculation_optional_exists.sh b/tests/docs/base/00_9default_calculation_optional_exists.sh new file mode 100644 index 0000000..64d620e --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional_exists.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory unique multiple My_variable. + Default: + + + • val1 + • val2 + | | rougail.my_calculated_variable string standard mandatory unique multiple + | My_calculated_variable. Default: the value of the variable "rougail.my_variable". + | diff --git a/tests/docs/base/00_9default_calculation_param_optional.sh b/tests/docs/base/00_9default_calculation_param_optional.sh new file mode 100644 index 0000000..ba70385 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_param_optional.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + default: + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + variable: _.var2 + optional: true + var3: + variable: _.var3 + optional: true + var4: + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard A first variable. + Default: returns a value. + rougail.var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/docs/base/00_9default_information_other_variable.sh b/tests/docs/base/00_9default_information_other_variable.sh new file mode 100644 index 0000000..7986379 --- /dev/null +++ b/tests/docs/base/00_9default_information_other_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                                                                        Description                                                                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A first variable. + rougail.var2 + string standard mandatory A second variable. + Default: the value of the information "test_information" of the variable "rougail.var1". + diff --git a/tests/docs/base/00_9default_integer.sh b/tests/docs/base/00_9default_integer.sh new file mode 100644 index 0000000..b31a575 --- /dev/null +++ b/tests/docs/base/00_9default_integer.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: 9 + choices: + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A variable. + Choices: choice for 0 to 9. + Default: 9 + diff --git a/tests/docs/base/00_9extra.json b/tests/docs/base/00_9extra.json index 56ae2a1..19d06e2 100644 --- a/tests/docs/base/00_9extra.json +++ b/tests/docs/base/00_9extra.json @@ -1 +1 @@ -{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "rougail", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "return no.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "rougail", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "description": "extra", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "return no.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9extra.sh b/tests/docs/base/00_9extra.sh new file mode 100644 index 0000000..d498997 --- /dev/null +++ b/tests/docs/base/00_9extra.sh @@ -0,0 +1,45 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: rougail # a variable +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: no + description: return no +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: rougail + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.variable + string standard mandatory A variable. + Default: return no. + diff --git a/tests/docs/base/00_9extra_calculation.json b/tests/docs/base/00_9extra_calculation.json index 18fb512..c1db3dd 100644 --- a/tests/docs/base/00_9extra_calculation.json +++ b/tests/docs/base/00_9extra_calculation.json @@ -1 +1 @@ -{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable1": {"type": "variable", "default": "the value of the variable \"rougail.variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "variable2": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}, "variable3": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable3"], "names": ["variable3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "description": "extra", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable1": {"type": "variable", "default": "the value of the variable \"rougail.variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "variable2": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}, "variable3": {"type": "variable", "default": "copy the value of rougail.variable.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["extra.variable3"], "names": ["variable3"], "descriptions": ["A third variable."]}}}} \ No newline at end of file diff --git a/tests/docs/base/00_9extra_calculation.sh b/tests/docs/base/00_9extra_calculation.sh new file mode 100644 index 0000000..8c048cd --- /dev/null +++ b/tests/docs/base/00_9extra_calculation.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: value # a variable +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + default: + variable: rougail.variable +variable2: + description: a second variable + default: + jinja: | + {{ rougail.variable }} + description: copy the value of rougail.variable +variable3: + description: a third variable + default: + jinja: | + {{ variable }} + params: + variable: + variable: rougail.variable + description: copy the value of rougail.variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: value + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                      Description                                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.variable1 + string standard mandatory A first variable. + Default: the value of the variable "rougail.variable". + extra.variable2 + string standard mandatory A second variable. + Default: copy the value of rougail.variable. + extra.variable3 + string standard mandatory A third variable. + Default: copy the value of rougail.variable. + diff --git a/tests/docs/base/01_6boolean_multi.sh b/tests/docs/base/01_6boolean_multi.sh new file mode 100644 index 0000000..1aa02b4 --- /dev/null +++ b/tests/docs/base/01_6boolean_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                                Description                                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + boolean standard mandatory unique multiple The first variable. + Default: true + rougail.var2 + boolean standard mandatory unique multiple The second variable. + Default: true + rougail.var3 + boolean standard mandatory unique multiple The third variable. + Default: true + rougail.var4 + boolean standard mandatory unique multiple The forth variable. + Default: false + rougail.var5 + boolean standard mandatory unique multiple The fifth variable. + Default: false + rougail.var6 + boolean standard mandatory unique multiple The sixth variable. + Default: false + rougail.var7 + boolean standard mandatory unique multiple The seventh variable. + Default: true + rougail.var8 + boolean standard mandatory unique multiple The eighth variable. + Default: true + diff --git a/tests/docs/base/01_6custom_multi.sh b/tests/docs/base/01_6custom_multi.sh new file mode 100644 index 0000000..5d9a233 --- /dev/null +++ b/tests/docs/base/01_6custom_multi.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.custom1 + custom basic mandatory unique multiple A first custom variable. + rougail.custom2 + custom standard mandatory unique multiple A second custom variable. + Default: value + diff --git a/tests/docs/base/01_6float_multi.sh b/tests/docs/base/01_6float_multi.sh new file mode 100644 index 0000000..5d714ba --- /dev/null +++ b/tests/docs/base/01_6float_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                              Description                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + float standard mandatory unique multiple The first variable. + Default: 0.0 + rougail.var2 + float standard mandatory unique multiple The second variable. + Default: 0.0 + rougail.var3 + float standard mandatory unique multiple The third variable. + Default: 0.0 + rougail.var4 + float standard mandatory unique multiple The forth variable. + Default: 10.1 + rougail.var5 + float standard mandatory unique multiple The fifth variable. + Default: 10.1 + rougail.var6 + float standard mandatory unique multiple The sixth variable. + Default: 10.1 + rougail.var7 + float standard mandatory unique multiple The seventh variable. + Default: 0.0 + rougail.var8 + float standard mandatory unique multiple The eighth variable. + Default: 0.0 + diff --git a/tests/docs/base/01_6number_multi.sh b/tests/docs/base/01_6number_multi.sh new file mode 100644 index 0000000..94691b7 --- /dev/null +++ b/tests/docs/base/01_6number_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + number standard mandatory unique multiple The first variable. + Default: 0 + rougail.var2 + number standard mandatory unique multiple The second variable. + Default: 0 + rougail.var3 + number standard mandatory unique multiple The third variable. + Default: 0 + rougail.var4 + number standard mandatory unique multiple The forth variable. + Default: 10 + rougail.var5 + number standard mandatory unique multiple The fifth variable. + Default: 10 + rougail.var6 + number standard mandatory unique multiple The sixth variable. + Default: 10 + rougail.var7 + number standard mandatory unique multiple The seventh variable. + Default: 0 + rougail.var8 + number standard mandatory unique multiple The eighth variable. + Default: 0 + diff --git a/tests/docs/base/01_6string_empty.sh b/tests/docs/base/01_6string_empty.sh new file mode 100644 index 0000000..97cb4ca --- /dev/null +++ b/tests/docs/base/01_6string_empty.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the second variable + empty: false + default: + - value + - +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple The second variable. + Default: + + + • value + • null + | diff --git a/tests/docs/base/01_6string_multi.sh b/tests/docs/base/01_6string_multi.sh new file mode 100644 index 0000000..ee20879 --- /dev/null +++ b/tests/docs/base/01_6string_multi.sh @@ -0,0 +1,78 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory unique multiple The first variable. + rougail.var2 + string basic mandatory unique multiple The second variable. + rougail.var3 + string basic mandatory The third variable. + rougail.var4 + string standard mandatory unique multiple The forth variable. + Default: value + rougail.var5 + string standard mandatory unique multiple The fifth variable. + Default: value + rougail.var6 + string standard mandatory unique multiple The sixth variable. + Default: value + rougail.var7 + string standard mandatory unique multiple The seventh variable. + Default: value + rougail.var8 + string standard mandatory unique multiple The eighth variable. + Default: value + diff --git a/tests/docs/base/01_7value_multi_doublequote.sh b/tests/docs/base/01_7value_multi_doublequote.sh new file mode 100644 index 0000000..bc50731 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: quote" + diff --git a/tests/docs/base/01_7value_multi_doublequote2.sh b/tests/docs/base/01_7value_multi_doublequote2.sh new file mode 100644 index 0000000..bf53930 --- /dev/null +++ b/tests/docs/base/01_7value_multi_doublequote2.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote'" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: quote'" + diff --git a/tests/docs/base/01_7value_multi_quote.sh b/tests/docs/base/01_7value_multi_quote.sh new file mode 100644 index 0000000..034072f --- /dev/null +++ b/tests/docs/base/01_7value_multi_quote.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: quote' + diff --git a/tests/docs/base/01_8calculation_information_multi.sh b/tests/docs/base/01_8calculation_information_multi.sh new file mode 100644 index 0000000..2edf7f5 --- /dev/null +++ b/tests/docs/base/01_8calculation_information_multi.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + multi: true + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: get information test_information. + diff --git a/tests/docs/base/01_9choice_variable_multi.sh b/tests/docs/base/01_9choice_variable_multi.sh new file mode 100644 index 0000000..81bf5ed --- /dev/null +++ b/tests/docs/base/01_9choice_variable_multi.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: # a first variable + - a + - b + - c +variable2: + description: a second variable + choices: + variable: _.variable1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                                       Description                                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + string standard mandatory unique multiple A first variable. + Default: + + + • a + • b + • c + | | rougail.variable2 choice basic mandatory + | A second variable. Choices: the value of the variable "rougail.variable1". + | diff --git a/tests/docs/base/04_0type_param.sh b/tests/docs/base/04_0type_param.sh new file mode 100644 index 0000000..672a689 --- /dev/null +++ b/tests/docs/base/04_0type_param.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A limited number + default: 10 + params: + min_number: 0 + max_number: 100 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.int + number standard mandatory A limited number. + Validators: + + + • the minimum value is 0 + • the maximum value is 100 Default: 10 | diff --git a/tests/docs/base/04_1auto_save.sh b/tests/docs/base/04_1auto_save.sh new file mode 100644 index 0000000..ce2f3c2 --- /dev/null +++ b/tests/docs/base/04_1auto_save.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                        Description                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory auto modified An auto save variable. + Default: no + diff --git a/tests/docs/base/04_1auto_save_and_calculated.sh b/tests/docs/base/04_1auto_save_and_calculated.sh new file mode 100644 index 0000000..22720bf --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + auto_save: true + default: + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                  Description                                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string basic mandatory auto modified A second variable. + Default: the value of the variable "rougail.var1". + diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.sh b/tests/docs/base/04_1auto_save_and_calculated_hidden.sh new file mode 100644 index 0000000..43b4290 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + auto_save: true + hidden: + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + jinja: yes + description: the value is always yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                                   Description                                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string basic mandatory hidden auto modified A second variable. + Default: the value is always yes. + Hidden: only if the variable var1 has value "yes". + diff --git a/tests/docs/base/04_1auto_save_and_hidden.sh b/tests/docs/base/04_1auto_save_and_hidden.sh new file mode 100644 index 0000000..4443d01 --- /dev/null +++ b/tests/docs/base/04_1auto_save_and_hidden.sh @@ -0,0 +1,12 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: autosave variable + auto_save: true + hidden: true + default: yes + mandatory: false +``` diff --git a/tests/docs/base/04_1default_calculation_hidden.sh b/tests/docs/base/04_1default_calculation_hidden.sh new file mode 100644 index 0000000..2a5ff89 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                                 Description                                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: value + rougail.var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "rougail.var1" has the value "value". + rougail.var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/04_1default_calculation_hidden_2.sh b/tests/docs/base/04_1default_calculation_hidden_2.sh new file mode 100644 index 0000000..0ec9521 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden_2.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                                 Description                                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: value + rougail.var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "rougail.var1" has the value "value". + rougail.var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/04_5disabled_calculation.sh b/tests/docs/base/04_5disabled_calculation.sh new file mode 100644 index 0000000..5ff5bc1 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a conditional variable +variable1: + description: a first variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +variable2: + description: a second variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is egal to "yes" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                        Description                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A conditional variable. + Default: no + rougail.variable1 + string basic mandatory disabled A first variable. + Disabled: if condition is egal to "yes". + rougail.variable2 + string basic mandatory disabled A second variable. + Disabled: if condition is egal to "yes". + diff --git a/tests/docs/base/04_5disabled_calculation_default.sh b/tests/docs/base/04_5disabled_calculation_default.sh new file mode 100644 index 0000000..7823183 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_default.sh @@ -0,0 +1,61 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +condition: no # a condition + +var1: + description: a first variable + disabled: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: the value of condition + +var2: + description: a second variable + disabled: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                        Description                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory disabled A first variable. + Default: the value of condition. + Disabled: if condition is yes. + rougail.var2 + string standard mandatory disabled A second variable. + Default: the value of condition. + Disabled: if condition is yes. + diff --git a/tests/docs/base/04_5disabled_calculation_optional.sh b/tests/docs/base/04_5disabled_calculation_optional.sh new file mode 100644 index 0000000..028ffbb --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_optional.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + variable: _.unknown + optional: true + description: calculation from an unknown variable + mandatory: false +var2: + description: a second variable + hidden: + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + variable: _.condition + optional: true + description: calculation from an condition variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard hidden A first variable. + Hidden: calculation from an unknown variable. + rougail.var2 + string standard hidden A second variable. + Hidden: calculation from an condition variable. + diff --git a/tests/docs/base/04_5disabled_calculation_variable.sh b/tests/docs/base/04_5disabled_calculation_variable.sh new file mode 100644 index 0000000..d4c9ad0 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                     Description                                                                 + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: false + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable "rougail.condition" has the value "true". + diff --git a/tests/docs/base/04_5disabled_calculation_variable2.sh b/tests/docs/base/04_5disabled_calculation_variable2.sh new file mode 100644 index 0000000..24adaaa --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable2.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                     Description                                                                 + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable "rougail.condition" has the value "true". + diff --git a/tests/docs/base/04_5disabled_calculation_variable3.sh b/tests/docs/base/04_5disabled_calculation_variable3.sh new file mode 100644 index 0000000..4bb1cb1 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable3.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                    Description                                                                + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable "rougail.condition" has the value "yes". + diff --git a/tests/docs/base/04_5disabled_calculation_variable4.sh b/tests/docs/base/04_5disabled_calculation_variable4.sh new file mode 100644 index 0000000..8c69529 --- /dev/null +++ b/tests/docs/base/04_5disabled_calculation_variable4.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when_not: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                       Description                                                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable "rougail.condition" hasn't the value "yes". + diff --git a/tests/docs/base/04_5hidden_calculation.sh b/tests/docs/base/04_5hidden_calculation.sh new file mode 100644 index 0000000..64cb78b --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the condition +var1: + description: a first variable + default: no + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +var2: + description: a second variable + default: no + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                      Description                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: no + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: no + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5hidden_calculation2.sh b/tests/docs/base/04_5hidden_calculation2.sh new file mode 100644 index 0000000..d3e5145 --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation2.sh @@ -0,0 +1,58 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if _.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: the value of condition +var2: + description: a second variable + hidden: + jinja: | + {% if rougail.condition != "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: the value of condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                      Description                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: the value of condition. + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: the value of condition. + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.sh b/tests/docs/base/04_5hidden_calculation_default_calculation.sh new file mode 100644 index 0000000..390a67a --- /dev/null +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.sh @@ -0,0 +1,58 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ _.condition }} + description: returns the condition value +var2: + description: a second variable + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + default: + jinja: | + {{ rougail.condition }} + description: returns the condition value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                      Description                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: returns the condition value. + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: returns the condition value. + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5validators.sh b/tests/docs/base/04_5validators.sh new file mode 100644 index 0000000..664139b --- /dev/null +++ b/tests/docs/base/04_5validators.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A number + type: number + validators: + - jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.int + number basic mandatory A number. + Validator: the max value is 100. + diff --git a/tests/docs/base/04_5validators_differ.sh b/tests/docs/base/04_5validators_differ.sh new file mode 100644 index 0000000..ad9611d --- /dev/null +++ b/tests/docs/base/04_5validators_differ.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + test: + - another_value + type: string + default: oui + validators: + - jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Validator: var1 must be different than var2. + Default: oui + Example: another_value + rougail.var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/docs/base/04_5validators_multi.sh b/tests/docs/base/04_5validators_multi.sh new file mode 100644 index 0000000..41122ba --- /dev/null +++ b/tests/docs/base/04_5validators_multi.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A second variable. + Validator: check length is less than 10. + Default: + + + • no + • yes + | diff --git a/tests/docs/base/04_5validators_multi2.sh b/tests/docs/base/04_5validators_multi2.sh new file mode 100644 index 0000000..f2c7458 --- /dev/null +++ b/tests/docs/base/04_5validators_multi2.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A second variable. + Validator: check length is less than 3. + Default: + + + • no + • yes Examples: + • val1 + • val2 + | diff --git a/tests/docs/base/05_0multi_not_uniq.sh b/tests/docs/base/05_0multi_not_uniq.sh new file mode 100644 index 0000000..75d0753 --- /dev/null +++ b/tests/docs/base/05_0multi_not_uniq.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                      Description                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory multiple A variable. + Default: non + diff --git a/tests/docs/base/05_0multi_uniq.sh b/tests/docs/base/05_0multi_uniq.sh new file mode 100644 index 0000000..2c64918 --- /dev/null +++ b/tests/docs/base/05_0multi_uniq.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: non + diff --git a/tests/docs/base/12_1auto_save_expert.sh b/tests/docs/base/12_1auto_save_expert.sh new file mode 100644 index 0000000..c6d92a9 --- /dev/null +++ b/tests/docs/base/12_1auto_save_expert.sh @@ -0,0 +1,11 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + auto_save: true + mode: advanced + default: no +``` diff --git a/tests/docs/base/16_0redefine_description.sh b/tests/docs/base/16_0redefine_description.sh new file mode 100644 index 0000000..f113135 --- /dev/null +++ b/tests/docs/base/16_0redefine_description.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Redefine description +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +var: + description: Redefined + redefine: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory Redefined. + diff --git a/tests/docs/base/16_2family_redefine_calculation.sh b/tests/docs/base/16_2family_redefine_calculation.sh new file mode 100644 index 0000000..e06bb8b --- /dev/null +++ b/tests/docs/base/16_2family_redefine_calculation.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: + jinja: | + true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.family + +basic disabled + +Disabled: depends on a calculation. + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory Var1. + diff --git a/tests/docs/base/16_2family_redefine_disabled.sh b/tests/docs/base/16_2family_redefine_disabled.sh new file mode 100644 index 0000000..1bd1240 --- /dev/null +++ b/tests/docs/base/16_2family_redefine_disabled.sh @@ -0,0 +1,17 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` diff --git a/tests/docs/base/16_5exists_nonexists.sh b/tests/docs/base/16_5exists_nonexists.sh new file mode 100644 index 0000000..df8c889 --- /dev/null +++ b/tests/docs/base/16_5exists_nonexists.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A variable. + Default: no + rougail.var2 + string standard mandatory A new variable. + Default: yes + diff --git a/tests/docs/base/16_5exists_redefine.sh b/tests/docs/base/16_5exists_redefine.sh new file mode 100644 index 0000000..cbebb4d --- /dev/null +++ b/tests/docs/base/16_5exists_redefine.sh @@ -0,0 +1,26 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + exists: true + default: yes +var2: + description: a second variable + redefine: true + exists: true + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + hidden: true + default: no + mandatory: false +``` diff --git a/tests/docs/base/16_5redefine_calculation.sh b/tests/docs/base/16_5redefine_calculation.sh new file mode 100644 index 0000000..17b0b03 --- /dev/null +++ b/tests/docs/base/16_5redefine_calculation.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: + jinja: yes + description: returns yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: no + description: returns no +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: returns yes. + diff --git a/tests/docs/base/16_5redefine_choice.sh b/tests/docs/base/16_5redefine_choice.sh new file mode 100644 index 0000000..b93b5cf --- /dev/null +++ b/tests/docs/base/16_5redefine_choice.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + choice basic mandatory A variable. + Choices: + + + • a + • b | diff --git a/tests/docs/base/16_5redefine_default.sh b/tests/docs/base/16_5redefine_default.sh new file mode 100644 index 0000000..ff8f33f --- /dev/null +++ b/tests/docs/base/16_5redefine_default.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: no +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: yes + diff --git a/tests/docs/base/16_5redefine_default_calculation.sh b/tests/docs/base/16_5redefine_default_calculation.sh new file mode 100644 index 0000000..95bbcee --- /dev/null +++ b/tests/docs/base/16_5redefine_default_calculation.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/16_5redefine_family.sh b/tests/docs/base/16_5redefine_family.sh new file mode 100644 index 0000000..7e4047a --- /dev/null +++ b/tests/docs/base/16_5redefine_family.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + variable: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/16_5redefine_help.sh b/tests/docs/base/16_5redefine_help.sh new file mode 100644 index 0000000..b0e5ea1 --- /dev/null +++ b/tests/docs/base/16_5redefine_help.sh @@ -0,0 +1,44 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + +Redefine help family ok. + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string basic mandatory Redefine help. + Redefine help ok. + diff --git a/tests/docs/base/16_5redefine_hidden.sh b/tests/docs/base/16_5redefine_hidden.sh new file mode 100644 index 0000000..8ea19b8 --- /dev/null +++ b/tests/docs/base/16_5redefine_hidden.sh @@ -0,0 +1,17 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: no # a variable +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + hidden: true + mandatory: false +``` diff --git a/tests/docs/base/16_5redefine_multi.sh b/tests/docs/base/16_5redefine_multi.sh new file mode 100644 index 0000000..1cb1533 --- /dev/null +++ b/tests/docs/base/16_5redefine_multi.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: non +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique multiple A variable. + Default: non + diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.sh b/tests/docs/base/16_5redefine_remove_disable_calculation.sh new file mode 100644 index 0000000..012411a --- /dev/null +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + disabled: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +variable: + description: a variable + disabled: + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/16_5test_redefine.sh b/tests/docs/base/16_5test_redefine.sh new file mode 100644 index 0000000..d1bbf5c --- /dev/null +++ b/tests/docs/base/16_5test_redefine.sh @@ -0,0 +1,58 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +``` +# dictionaries/rougail/10-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + Example: test1 + rougail.var2 + string standard mandatory A second variable. + Default: non + Example: test1 + rougail.var3 + string basic mandatory A third variable. + diff --git a/tests/docs/base/16_6choice_redefine.sh b/tests/docs/base/16_6choice_redefine.sh new file mode 100644 index 0000000..bbdc6c1 --- /dev/null +++ b/tests/docs/base/16_6choice_redefine.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +var: + redefine: true + choices: + - a + - c +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A choice. + Choices: + + + • a + • c ← (default) | diff --git a/tests/docs/base/16exists_exists.sh b/tests/docs/base/16exists_exists.sh new file mode 100644 index 0000000..833be92 --- /dev/null +++ b/tests/docs/base/16exists_exists.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var: + description: New description + exists: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Description +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory Description. + diff --git a/tests/docs/base/17_5redefine_leadership.sh b/tests/docs/base/17_5redefine_leadership.sh new file mode 100644 index 0000000..ce9f7b3 --- /dev/null +++ b/tests/docs/base/17_5redefine_leadership.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: # a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/base/20_0empty_family.sh b/tests/docs/base/20_0empty_family.sh new file mode 100644 index 0000000..cc79b77 --- /dev/null +++ b/tests/docs/base/20_0empty_family.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + type: family +``` diff --git a/tests/docs/base/20_0family_append.sh b/tests/docs/base/20_0family_append.sh new file mode 100644 index 0000000..5396702 --- /dev/null +++ b/tests/docs/base/20_0family_append.sh @@ -0,0 +1,38 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + var2: + description: The second variable +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: A family + var1: + description: The first variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory The first variable. + rougail.family.var2 + string basic mandatory The second variable. + diff --git a/tests/docs/base/20_0family_underscore.sh b/tests/docs/base/20_0family_underscore.sh new file mode 100644 index 0000000..932db63 --- /dev/null +++ b/tests/docs/base/20_0family_underscore.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +my_family: + _type: family + _description: This is a great family + _help: This is a great family + _mode: standard + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + mandatory: false + description: + description: This is a other great family + my_variable: + mandatory: false + help: + description: a help family + help: This is a other great family + my_variable: + mandatory: false + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + mandatory: false + disabled: + description: an disabled family + disabled: true + my_variable: + mandatory: false +``` diff --git a/tests/docs/base/20_0multi_family.sh b/tests/docs/base/20_0multi_family.sh new file mode 100644 index 0000000..8b5cd5e --- /dev/null +++ b/tests/docs/base/20_0multi_family.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +standard + + a sub family + +standard + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string standard A variable. + diff --git a/tests/docs/base/20_0multi_family_basic.sh b/tests/docs/base/20_0multi_family_basic.sh new file mode 100644 index 0000000..a0f2459 --- /dev/null +++ b/tests/docs/base/20_0multi_family_basic.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + a sub family + +basic + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/20_0multi_family_expert.sh b/tests/docs/base/20_0multi_family_expert.sh new file mode 100644 index 0000000..daa11eb --- /dev/null +++ b/tests/docs/base/20_0multi_family_expert.sh @@ -0,0 +1,13 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + mode: advanced + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` diff --git a/tests/docs/base/20_0multi_family_order.sh b/tests/docs/base/20_0multi_family_order.sh new file mode 100644 index 0000000..a29f0cb --- /dev/null +++ b/tests/docs/base/20_0multi_family_order.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory A variable. + + + + a family + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable1 + string basic mandatory A first variable. + + + a sub family + +basic + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string basic mandatory A variable. + + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable2 + string basic mandatory A second variable. + diff --git a/tests/docs/base/20_0validators_differ_redefine.sh b/tests/docs/base/20_0validators_differ_redefine.sh new file mode 100644 index 0000000..fc6e941 --- /dev/null +++ b/tests/docs/base/20_0validators_differ_redefine.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var3: + redefine: true + validators: + - jinja: | + {% if _.var3 == _.var2 %} + var3 must be different than var2 + {% endif %} + description: var3 must be different than var2 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: no # a second variable +var3: + description: a third variable + default: yes + test: + - yes + validators: + - jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string standard mandatory A second variable. + Default: no + rougail.var3 + string standard mandatory A third variable. + Validator: var3 must be different than var2. + Default: yes + Example: yes + diff --git a/tests/docs/base/20_1empty_subfamily.sh b/tests/docs/base/20_1empty_subfamily.sh new file mode 100644 index 0000000..7a52420 --- /dev/null +++ b/tests/docs/base/20_1empty_subfamily.sh @@ -0,0 +1,9 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + my_sub_family: + type: family +``` diff --git a/tests/docs/base/20_9default_information_parent.sh b/tests/docs/base/20_9default_information_parent.sh new file mode 100644 index 0000000..5b61a39 --- /dev/null +++ b/tests/docs/base/20_9default_information_parent.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.family + +basic + + + + + +  Variable                                                                                          Description                                                                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory A first variable. + rougail.family.var2 + string standard mandatory A second variable. + Default: the value of the information "test_information" of the variable "rougail.family". + diff --git a/tests/docs/base/24_0family_hidden_condition.sh b/tests/docs/base/24_0family_hidden_condition.sh new file mode 100644 index 0000000..ee3feb3 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition.sh @@ -0,0 +1,44 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + var1: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.sh b/tests/docs/base/24_0family_hidden_condition_boolean.sh new file mode 100644 index 0000000..380f55c --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_boolean.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a conditional variable +family: + description: a family + hidden: + jinja: | + {% if not rougail.condition %} + condition is false + {% endif %} + description: if not condition + variable: + description: a variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A conditional variable. + Default: false + + + + a family + +standard hidden + +Hidden: if not condition. + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string standard A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.sh b/tests/docs/base/24_0family_hidden_condition_sub_family.sh new file mode 100644 index 0000000..99f3050 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.sh @@ -0,0 +1,49 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + rougail.family.subfamily + +basic + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh new file mode 100644 index 0000000..0611789 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # the variable use has condition +family: + description: possibly hidden family + hidden: + variable: _.condition + subfamily: # a subfamily + var1: + description: a variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory The variable use has condition. + Default: true + + + + possibly hidden family + +standard hidden + +Hidden: when the variable "rougail.condition" has the value "true". + + a subfamily + +standard + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.var1 + string standard A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.sh b/tests/docs/base/24_0family_hidden_condition_with_variable.sh new file mode 100644 index 0000000..0a9f7d7 --- /dev/null +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition1: false # a first conditional variable +condition2: false # a second conditional variable +family: + description: a family + hidden: + jinja: | + {% if not rougail.condition1 %} + condition1 is false + {% endif %} + description: if condition1 is false + variable: + description: a variable + hidden: + jinja: | + {% if rougail.condition2 %} + condition2 is true + {% endif %} + description: if condition2 is false + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition1 + boolean standard mandatory A first conditional variable. + Default: false + rougail.condition2 + boolean standard mandatory A second conditional variable. + Default: false + + + + a family + +standard hidden + +Hidden: if condition1 is false. + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string standard hidden A variable. + Hidden: if condition2 is false. + diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh b/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh new file mode 100644 index 0000000..85dbe4c --- /dev/null +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + a subfamily + +basic + + + +  Variable                              Description                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.sub_family.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_mandatory_condition.sh b/tests/docs/base/24_0family_mandatory_condition.sh new file mode 100644 index 0000000..c6a5c2d --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var + string standard mandatory A variable. + Mandatory: only if rougail.condition has the value "yes". + diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.sh b/tests/docs/base/24_0family_mandatory_condition_variable.sh new file mode 100644 index 0000000..f65a7a3 --- /dev/null +++ b/tests/docs/base/24_0family_mandatory_condition_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                      Description                                                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + rougail.var + string standard mandatory A variable. + Mandatory: when the variable "rougail.condition" has the value "true". + diff --git a/tests/docs/base/24_7validators_variable_optional.sh b/tests/docs/base/24_7validators_variable_optional.sh new file mode 100644 index 0000000..ba3ca27 --- /dev/null +++ b/tests/docs/base/24_7validators_variable_optional.sh @@ -0,0 +1,55 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +general: # a family + int: + description: a first number + type: number + test: + - 5 + validators: + - jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + variable: _.int2 + optional: true + description: int and int2 must be different + - jinja: | + {% if int3 is defined and _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.int + number basic mandatory A first number. + Validators: + + + • int and int2 must be different. + • int and int3 must be different. Example: 5 | | rougail.general.int2 number standard + mandatory | A second number. Default: 1 + | diff --git a/tests/docs/base/24_family_disabled_var_hidden.sh b/tests/docs/base/24_family_disabled_var_hidden.sh new file mode 100644 index 0000000..ea598d4 --- /dev/null +++ b/tests/docs/base/24_family_disabled_var_hidden.sh @@ -0,0 +1,16 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +``` diff --git a/tests/docs/base/40_0leadership.sh b/tests/docs/base/40_0leadership.sh new file mode 100644 index 0000000..f3b05e0 --- /dev/null +++ b/tests/docs/base/40_0leadership.sh @@ -0,0 +1,36 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: # a follower + follower2: # an other follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique multiple A leader. + rougail.leader.follower1 + string basic mandatory A follower. + rougail.leader.follower2 + string basic mandatory An other follower. + diff --git a/tests/docs/base/40_0leadership_diff_name.sh b/tests/docs/base/40_0leadership_diff_name.sh new file mode 100644 index 0000000..bd1830a --- /dev/null +++ b/tests/docs/base/40_0leadership_diff_name.sh @@ -0,0 +1,36 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leadership.leader + string basic mandatory unique multiple A leader. + rougail.leadership.follower1 + string basic mandatory A follower. + rougail.leadership.follower2 + string basic mandatory An other follower. + diff --git a/tests/docs/base/40_0leadership_empty.sh b/tests/docs/base/40_0leadership_empty.sh new file mode 100644 index 0000000..9ba2e94 --- /dev/null +++ b/tests/docs/base/40_0leadership_empty.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +empty_leader: + type: leadership +``` diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.sh b/tests/docs/base/40_0leadership_follower_default_calculation.sh new file mode 100644 index 0000000..d196606 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_calculation.sh @@ -0,0 +1,45 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: value # a follower + follower2: + description: a second follower + default: + jinja: | + {{ _.follower1 }} + description: returns follower1 value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique multiple A leader. + rougail.leader.follower1 + string standard mandatory A follower. + Default: value + rougail.leader.follower2 + string standard mandatory A second follower. + Default: returns follower1 value. + diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.sh b/tests/docs/base/40_0leadership_follower_default_submulti.sh new file mode 100644 index 0000000..f5d872d --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti.sh @@ -0,0 +1,50 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - leader + follower1: # a follower1 + - value + follower2: # a follower2 + - value1 + - value2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple A leader. + Default: leader + rougail.leader.follower1 + string standard mandatory multiple A follower1. + Default: value + rougail.leader.follower2 + string standard mandatory multiple A follower2. + Default: + + + • value1 + • value2 + | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh new file mode 100644 index 0000000..d7924fc --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh @@ -0,0 +1,48 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # the leader + - leader + follower1: # the follower1 + - value + follower2: + description: the follower2 + multi: true + default: + variable: _.follower1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                                              Description                                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple The leader. + Default: leader + rougail.leader.follower1 + string standard mandatory multiple The follower1. + Default: value + rougail.leader.follower2 + string standard mandatory multiple The follower2. + Default: the value of the variable "rougail.leader.follower1". + diff --git a/tests/docs/base/40_0leadership_follower_default_value.sh b/tests/docs/base/40_0leadership_follower_default_value.sh new file mode 100644 index 0000000..1aca439 --- /dev/null +++ b/tests/docs/base/40_0leadership_follower_default_value.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower1 + string standard mandatory A follower with default value. + Default: value + diff --git a/tests/docs/base/40_0leadership_leader_not_multi.sh b/tests/docs/base/40_0leadership_leader_not_multi.sh new file mode 100644 index 0000000..02c2e92 --- /dev/null +++ b/tests/docs/base/40_0leadership_leader_not_multi.sh @@ -0,0 +1,67 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.general + +standard + + + + +  Variable                                    Description                                + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.mode_conteneur_actif + string standard mandatory No change. + Default: non + + + + rougail.general1 + +basic + + rougail.general1.leader + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general1.leader.leader + string basic mandatory unique multiple Leader. + rougail.general1.leader.follower1 + string basic mandatory Follower1. + rougail.general1.leader.follower2 + string basic mandatory Follower2. + diff --git a/tests/docs/base/40_1leadership_append_follower.sh b/tests/docs/base/40_1leadership_append_follower.sh new file mode 100644 index 0000000..0adfe93 --- /dev/null +++ b/tests/docs/base/40_1leadership_append_follower.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: the follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique multiple The leader. + rougail.leader.follower1 + string basic mandatory The follower1. + rougail.leader.follower2 + string basic mandatory The follower2. + rougail.leader.follower3 + string basic mandatory The follower3. + diff --git a/tests/docs/base/40_2leadership_calculation_index.sh b/tests/docs/base/40_2leadership_calculation_index.sh new file mode 100644 index 0000000..2668010 --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_index.sh @@ -0,0 +1,45 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + type: index +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple A leader. + Default: + + + • a + • b + • c + | | rougail.leader.follower1 number standard mandatory + | A follower. Default: the value of the index. + | diff --git a/tests/docs/base/40_2leadership_calculation_param_index.sh b/tests/docs/base/40_2leadership_calculation_param_index.sh new file mode 100644 index 0000000..09e3f7c --- /dev/null +++ b/tests/docs/base/40_2leadership_calculation_param_index.sh @@ -0,0 +1,49 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: leadership + type: leadership + leader: # a leader + - a + - b + - c + follower1: + description: a follower + type: number + default: + jinja: '{{ index }}' + params: + index: + type: index + description: returns index +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple A leader. + Default: + + + • a + • b + • c + | | rougail.leader.follower1 number standard mandatory + | A follower. Default: returns index. + | diff --git a/tests/docs/base/40_2leadership_leader_calculation.sh b/tests/docs/base/40_2leadership_leader_calculation.sh new file mode 100644 index 0000000..b87afc6 --- /dev/null +++ b/tests/docs/base/40_2leadership_leader_calculation.sh @@ -0,0 +1,49 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + type: leadership + + leader: + description: a leader + multi: true + default: + jinja: | + val1 + val2 + description: returns val1 and val2 + + follower1: # a first follower + + follower2: # a second follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple A leader. + Default: returns val1 and val2. + rougail.leader.follower1 + string basic mandatory A first follower. + rougail.leader.follower2 + string basic mandatory A second follower. + diff --git a/tests/docs/base/40_6leadership_follower_multi.sh b/tests/docs/base/40_6leadership_follower_multi.sh new file mode 100644 index 0000000..855d474 --- /dev/null +++ b/tests/docs/base/40_6leadership_follower_multi.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leadership.leader + string basic mandatory unique multiple The leader. + rougail.leadership.follower1 + string basic mandatory multiple The first follower. + rougail.leadership.follower2 + string standard mandatory multiple The second follower. + Default: value + diff --git a/tests/docs/base/40_8calculation_boolean.sh b/tests/docs/base/40_8calculation_boolean.sh new file mode 100644 index 0000000..7e690b3 --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +bool: false # a boolean variable +multi1: + description: a first multi variable + type: boolean + multi: true + default: + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                Description                                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.bool + boolean standard mandatory A boolean variable. + Default: false + rougail.multi1 + boolean standard mandatory unique multiple A first multi variable. + Default: a calculation. + rougail.multi2 + boolean standard mandatory unique multiple A second multi variable. + Default: a calculation. + diff --git a/tests/docs/base/40_8calculation_boolean_return_none.sh b/tests/docs/base/40_8calculation_boolean_return_none.sh new file mode 100644 index 0000000..3f28568 --- /dev/null +++ b/tests/docs/base/40_8calculation_boolean_return_none.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: yes # a first variable +var2: + description: a second variable + type: boolean + default: + jinja: | + {% if rougail.var1 == 'no' %} + false + {% endif %} + description: return false if the value of var1 is "no" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                   Description                                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: yes + rougail.var2 + boolean standard mandatory A second variable. + Default: return false if the value of var1 is "no". + diff --git a/tests/docs/base/40_8calculation_integer.sh b/tests/docs/base/40_8calculation_integer.sh new file mode 100644 index 0000000..35ecf51 --- /dev/null +++ b/tests/docs/base/40_8calculation_integer.sh @@ -0,0 +1,44 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +bool: false # a boolean variable +int1: + description: first integer variable + type: number + default: + jinja: | + {% if rougail.bool %}1{% else %}2{% endif %} + description: if bool returns 1 otherwise return 2 +int2: + description: second integer variable + type: number + default: + jinja: | + {% if not rougail.bool %}3{% else %}4{% endif %} + description: if bool returns 3 otherwise return 4 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                              Description                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.bool + boolean standard mandatory A boolean variable. + Default: false + rougail.int1 + number standard mandatory First integer variable. + Default: if bool returns 1 otherwise return 2. + rougail.int2 + number standard mandatory Second integer variable. + Default: if bool returns 3 otherwise return 4. + diff --git a/tests/docs/base/40_8calculation_multi_variable.sh b/tests/docs/base/40_8calculation_multi_variable.sh new file mode 100644 index 0000000..d342368 --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + default: + - variable: _.var2 + - variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A first variable. + Default: + + + • the value of the variable "rougail.var2". + • the value of the variable "rougail.var3". + | | rougail.var2 string standard mandatory + | A second variable. Default: no + | | rougail.var3 string standard mandatory + | A third variable. Default: yes + | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.sh b/tests/docs/base/40_8calculation_multi_variable_parent.sh new file mode 100644 index 0000000..8a2d5db --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent.sh @@ -0,0 +1,40 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: no # a variable +fam1: # a family + var: + description: a calculated variable + default: + variable: __.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A variable. + Default: no + + + + a family + +standard + + + + +  Variable                                                 Description                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam1.var + string standard mandatory A calculated variable. + Default: the value of the variable "rougail.var". + diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.sh b/tests/docs/base/40_8calculation_multi_variable_parent2.sh new file mode 100644 index 0000000..7981f9e --- /dev/null +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +fam1: # first family + var: no # a variable +fam2: # second family + var: + description: a varaible + default: + variable: __.fam1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + first family + +standard + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam1.var + string standard mandatory A variable. + Default: no + + + + second family + +standard + + + + +  Variable                                                      Description                                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam2.var + string standard mandatory A varaible. + Default: the value of the variable "rougail.fam1.var". + diff --git a/tests/docs/base/41_0choice_leader.sh b/tests/docs/base/41_0choice_leader.sh new file mode 100644 index 0000000..54f53bd --- /dev/null +++ b/tests/docs/base/41_0choice_leader.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + The leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple The leader. + rougail.leader.follower1 + choice basic mandatory A follower. + Choices: + + + • a + • b + • c | diff --git a/tests/docs/base/44_0leadership_hidden.sh b/tests/docs/base/44_0leadership_hidden.sh new file mode 100644 index 0000000..8a12034 --- /dev/null +++ b/tests/docs/base/44_0leadership_hidden.sh @@ -0,0 +1,19 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + hidden: true + type: leadership + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/base/44_0leadership_leader_hidden.sh b/tests/docs/base/44_0leadership_leader_hidden.sh new file mode 100644 index 0000000..003b3f1 --- /dev/null +++ b/tests/docs/base/44_0leadership_leader_hidden.sh @@ -0,0 +1,20 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + type: leadership + + leader: + description: a leader + multi: true + hidden: true + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.sh b/tests/docs/base/44_1leadership_append_hidden_follower.sh new file mode 100644 index 0000000..ba8548b --- /dev/null +++ b/tests/docs/base/44_1leadership_append_hidden_follower.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: follower3 + mandatory: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false +``` diff --git a/tests/docs/base/44_4disabled_calcultion_follower.sh b/tests/docs/base/44_4disabled_calcultion_follower.sh new file mode 100644 index 0000000..425c4f9 --- /dev/null +++ b/tests/docs/base/44_4disabled_calcultion_follower.sh @@ -0,0 +1,57 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +leader: + description: a leadership + type: leadership + leader: + description: aleader + default: + - a + follower: + description: a follower + disabled: + jinja: | + {% if rougail.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple Aleader. + Default: a + rougail.leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/docs/base/44_4leadership_mandatory.sh b/tests/docs/base/44_4leadership_mandatory.sh new file mode 100644 index 0000000..e3291bd --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique multiple A leader. + rougail.leader.follower1 + string standard A follower. + diff --git a/tests/docs/base/44_4leadership_mandatory_follower.sh b/tests/docs/base/44_4leadership_mandatory_follower.sh new file mode 100644 index 0000000..f22e59c --- /dev/null +++ b/tests/docs/base/44_4leadership_mandatory_follower.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.sh b/tests/docs/base/44_5leadership_leader_hidden_calculation.sh new file mode 100644 index 0000000..cb8f28f --- /dev/null +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + mandatory: false + follower: # a follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + + + + a leadership + +basic hidden + +Hidden: if condition is no. + +This family contains lists of variable blocks. + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.sh b/tests/docs/base/44_6leadership_follower_disabled_calculation.sh new file mode 100644 index 0000000..c55974c --- /dev/null +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower: + description: a follower + disabled: + jinja: | + {% if __.condition == "yes" %} + disabled + {% endif %} + description: if condition is yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique multiple A leader. + rougail.leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.sh b/tests/docs/base/44_9calculated_default_leadership_leader.sh new file mode 100644 index 0000000..085cdcb --- /dev/null +++ b/tests/docs/base/44_9calculated_default_leadership_leader.sh @@ -0,0 +1,48 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +leader: + description: leader + type: leadership + leader: # a leader + - a + - b + follower: + description: a follower + disabled: + jinja: | + {% if _.leader == "a" %} + the value of "leader" is "a" + {% endif %} + description: if the value of "leader" is "a" + default: + variable: _.leader +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.leader + +standard + +This family contains lists of variable blocks. + + + + +  Variable                                                           Description                                                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique multiple A leader. + Default: + + + • a + • b + | | rougail.leader.follower string standard mandatory disabled + | A follower. Default: the value of the variable "rougail.leader.leader". Disabled: if the value of "leader" is "a". + | diff --git a/tests/docs/base/60_0family_dynamic.sh b/tests/docs/base/60_0family_dynamic.sh new file mode 100644 index 0000000..ae94425 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: # A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_0.sh b/tests/docs/base/60_0family_dynamic_1_0.sh new file mode 100644 index 0000000..ad72e0e --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + type: dynamic + variable: rougail.var + vardyn: + description: Dynamic variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard Dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.sh b/tests/docs/base/60_0family_dynamic_1_0_type.sh new file mode 100644 index 0000000..0181742 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_0_type.sh @@ -0,0 +1,53 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + default: + - val1 + - val2 +dyn: + _type: dynamic + variable: rougail.var + vardyn: + description: A dyn variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dyn variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_1.sh b/tests/docs/base/60_0family_dynamic_1_1.sh new file mode 100644 index 0000000..7481d7b --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_1_1.sh @@ -0,0 +1,51 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.sh b/tests/docs/base/60_0family_dynamic_jinja_number.sh new file mode 100644 index 0000000..ba2660b --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_jinja_number.sh @@ -0,0 +1,68 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - 1 + - 2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +var2: + description: a variable + default: + jinja: | + {{ rougail.dyn1.var }} + description: get the value of rougail.dyn1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + number standard mandatory unique multiple A suffix variable. + Default: + + + • 1 + • 2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn1.var + rougail.dyn2.var + string standard mandatory A variable inside dynamic family. + Default: val + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable. + Default: get the value of rougail.dyn1.var. + diff --git a/tests/docs/base/60_0family_dynamic_no_description.sh b/tests/docs/base/60_0family_dynamic_no_description.sh new file mode 100644 index 0000000..7aceb8b --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_no_description.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_0family_dynamic_static.sh b/tests/docs/base/60_0family_dynamic_static.sh new file mode 100644 index 0000000..9ab2e9e --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_static.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A variable inside a dynamic family. + diff --git a/tests/docs/base/60_0family_dynamic_test.sh b/tests/docs/base/60_0family_dynamic_test.sh new file mode 100644 index 0000000..f9e8f27 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_test.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.sh b/tests/docs/base/60_0family_dynamic_variable_empty.sh new file mode 100644 index 0000000..fbcc369 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_empty.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: [] # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory unique multiple A suffix variable. + + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynexample.var + string standard mandatory A variable inside dynamic family. + Default: val + diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.sh b/tests/docs/base/60_0family_dynamic_variable_suffix.sh new file mode 100644 index 0000000..46191ee --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: a value # A dynamic variable with suffix {{ identifier }} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/docs/base/60_0family_empty.sh b/tests/docs/base/60_0family_empty.sh new file mode 100644 index 0000000..9592dac --- /dev/null +++ b/tests/docs/base/60_0family_empty.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +general2: + type: family +``` diff --git a/tests/docs/base/60_0family_hidden.sh b/tests/docs/base/60_0family_hidden.sh new file mode 100644 index 0000000..c589227 --- /dev/null +++ b/tests/docs/base/60_0family_hidden.sh @@ -0,0 +1,19 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: a variable + mandatory: false +``` diff --git a/tests/docs/base/60_0family_mode.sh b/tests/docs/base/60_0family_mode.sh new file mode 100644 index 0000000..51dbd5f --- /dev/null +++ b/tests/docs/base/60_0family_mode.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var + string basic mandatory A variable. + Default: non + diff --git a/tests/docs/base/60_1family_dynamic_jinja.sh b/tests/docs/base/60_1family_dynamic_jinja.sh new file mode 100644 index 0000000..ab8638d --- /dev/null +++ b/tests/docs/base/60_1family_dynamic_jinja.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: index of suffix value. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn1.var + rougail.dyn2.var + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh new file mode 100644 index 0000000..44ba8c9 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh @@ -0,0 +1,71 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + a family + +basic + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh new file mode 100644 index 0000000..3c1741f --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh @@ -0,0 +1,77 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: identifier +var2: + description: a varible outside dynamic family + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A identifier variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a family inside dynamic family + +standard + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the identifier. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.sh b/tests/docs/base/60_2family_dynamic_outside_calc.sh new file mode 100644 index 0000000..eb33278 --- /dev/null +++ b/tests/docs/base/60_2family_dynamic_outside_calc.sh @@ -0,0 +1,68 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + jinja: | + {{ _.dynval1.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A suffx variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.newvar + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/docs/base/60_5family_dynamic_calc2.sh b/tests/docs/base/60_5family_dynamic_calc2.sh new file mode 100644 index 0000000..903f275 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc2.sh @@ -0,0 +1,67 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +var2: # a second variable + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + hidden: + jinja: | + {% if _.var2 == "no" %} + var2 is no + {% endif %} + description: if var2 is no + + vardyn: val # a dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | | rougail.var2 string basic mandatory + | A second variable. + | + + + A dynamic family + +standard hidden + +Hidden: if var2 is no. + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.sh b/tests/docs/base/60_5family_dynamic_calc_suffix.sh new file mode 100644 index 0000000..6a645e4 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.sh @@ -0,0 +1,70 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: A suffix variable + default: + - val1 + - val2 + +dyn{{ identifier }}: + dynamic: + variable: _.var1 + + var: + description: A dynamic variable + +var2: + description: A variable calculated + default: + variable: rougail.dynval1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: the value of the variable "rougail.dynval1.var". + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.sh b/tests/docs/base/60_5family_dynamic_calc_suffix2.sh new file mode 100644 index 0000000..386997f --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.sh @@ -0,0 +1,55 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: Suffix has value + default: + type: identifier +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory Suffix has value. + Default: the value of the identifier. + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh new file mode 100644 index 0000000..151c77d --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + dynamic: + - val1 + - val2 + var: + description: A dynamic variable + disabled: + type: identifier + when: val1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + + +  Variable                                        Description                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory disabled A dynamic variable. + Disabled: when the identifier is "val1". + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh b/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh new file mode 100644 index 0000000..6ad2b28 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + default: + jinja: | + {{ identifier }} + params: + identifier: + type: identifier + description: from suffix +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A identifier variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.sh b/tests/docs/base/60_5family_dynamic_calc_variable.sh new file mode 100644 index 0000000..ea25787 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_variable.sh @@ -0,0 +1,67 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ identifier }}: + dynamic: + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + variable: _.dynval1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: the value of the variable "rougail.dynval1.var". + diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.sh b/tests/docs/base/60_5family_dynamic_hidden_suffix.sh new file mode 100644 index 0000000..b9cfffc --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + hidden: + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: identifier + description: if suffix == 'val2' + + var: + description: a variable + mandatory: false + family: # a family + var: + description: a new variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +standard hidden + +Hidden: if suffix == 'val2'. + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                     Description                 + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard A variable. + + + a family + +standard + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string standard A new variable. + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.sh b/tests/docs/base/60_5family_dynamic_variable_outside.sh new file mode 100644 index 0000000..3ab1a46 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside.sh @@ -0,0 +1,75 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the identifier. + + + + + +  Variable                                                          Description                                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique multiple A variable. + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.sh b/tests/docs/base/60_5family_dynamic_variable_outside2.sh new file mode 100644 index 0000000..d97f42f --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside2.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var + +var: # a suffix variable + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                                          Description                                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique multiple A variable. + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | | rougail.var string standard mandatory unique multiple + | A suffix variable. Default: + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                                          Description                                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the identifier. + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh new file mode 100644 index 0000000..b18f467 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh @@ -0,0 +1,77 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + jinja: |- + {%- for v in var %} + {{ v }} + {%- endfor -%} + params: + var: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the identifier. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique multiple A variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh new file mode 100644 index 0000000..2bf8f87 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside dynamic family + default: + type: identifier +var2: + description: a variable + default: + variable: _.dyn_val1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn_val1.var + rougail.dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the identifier. + + + + + +  Variable                                                          Description                                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable. + Default: the value of the variable "rougail.dyn_val1.var". + diff --git a/tests/docs/base/60_6family_dynamic_inside.sh b/tests/docs/base/60_6family_dynamic_inside.sh new file mode 100644 index 0000000..46986fa --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_inside.sh @@ -0,0 +1,85 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 + +'{{ identifier }}_dyn': + description: a dynamic family + dynamic: + variable: _.var + var1: + description: value is suffix + default: + type: identifier + var2: + description: value is first variable + default: + variable: rougail.{{ identifier }}_dyn.var1 + var3: + description: value is relative first variable + default: + variable: _.var1 + var4: + description: value is first variable of val1 + default: + variable: rougail.val1_dyn.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + + + +  Variable                                                           Description                                                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.val1_dyn.var1 + rougail.val2_dyn.var1 + string standard mandatory Value is suffix. + Default: the value of the identifier. + rougail.val1_dyn.var2 + rougail.val2_dyn.var2 + string standard mandatory Value is first variable. + Default: + + + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var3 rougail.val2_dyn.var3 string standard mandatory + | Value is relative first variable. Default: + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var4 rougail.val2_dyn.var4 string standard mandatory + | Value is first variable of val1. Default: the value of the variable "rougail.val1_dyn.var1". + | diff --git a/tests/docs/base/60_6family_dynamic_leadership.sh b/tests/docs/base/60_6family_dynamic_leadership.sh new file mode 100644 index 0000000..76dd22b --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_leadership.sh @@ -0,0 +1,77 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.leadership.leader + rougail.dynval2.leadership.leader + string basic mandatory unique multiple A leader. + rougail.dynval1.leadership.follower1 + rougail.dynval2.leadership.follower1 + string standard A follower1. + rougail.dynval1.leadership.follower2 + rougail.dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.sh b/tests/docs/base/60_6family_dynamic_sub_dynamic.sh new file mode 100644 index 0000000..6a8d828 --- /dev/null +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.sh @@ -0,0 +1,135 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + multi: true + default: + jinja: | + {% for val in __.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + dyn_{{ identifier }}: + description: a Second dynamic variable + dynamic: + variable: rougail.dyn{{ identifier }}.var + var: + description: A variable dynamic + default: + type: identifier + var_identifier: + description: identifier from first family + default: + type: identifier + identifier: 0 + var_identifiers: + description: merge identifiers + default: + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: identifier + identifier: 0 + s2: + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A identifier variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory unique multiple A dynamic variable. + Default: add 't' to each var value. + + + a Second dynamic variable + +standard + +This family builds families dynamically. + +Identifiers: + + • the value of the variable "rougail.dynval1.var" + • the value of the variable "rougail.dynval2.var" + + + + + + + + + + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.dyn_tval1.var + rougail.dynval1.dyn_tval2.var + rougail.dynval2.dyn_tval1.var + rougail.dynval2.dyn_tval2.var + string standard mandatory A variable dynamic. + Default: the value of the identifier. + rougail.dynval1.dyn_tval1.var_identifier + rougail.dynval1.dyn_tval2.var_identifier + rougail.dynval2.dyn_tval1.var_identifier + rougail.dynval2.dyn_tval2.var_identifier + string standard mandatory Identifier from first family. + Default: the value of the identifier. + rougail.dynval1.dyn_tval1.var_identifiers + rougail.dynval1.dyn_tval2.var_identifiers + rougail.dynval2.dyn_tval1.var_identifiers + rougail.dynval2.dyn_tval2.var_identifiers + string standard mandatory Merge identifiers. + Default: join identifier 1 et identifier 2. + diff --git a/tests/docs/base/60_9extra_dynamic.json b/tests/docs/base/60_9extra_dynamic.json index 0a3679a..22aefcb 100644 --- a/tests/docs/base/60_9extra_dynamic.json +++ b/tests/docs/base/60_9extra_dynamic.json @@ -1 +1 @@ -{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."], "multiple": true}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A variable."], "multiple": true}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "description": "extra", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_9extra_dynamic.sh b/tests/docs/base/60_9extra_dynamic.sh new file mode 100644 index 0000000..8d8d187 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: # a variable + - a +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: 1.1 +dyn_{{ identifier }}: + dynamic: + variable: rougail.var + var: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique multiple A variable. + Default: a + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + extra.dyn_a + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.dyn_a.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_9extra_dynamic_extra.json b/tests/docs/base/60_9extra_dynamic_extra.json index 115c304..5413420 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.json +++ b/tests/docs/base/60_9extra_dynamic_extra.json @@ -1 +1 @@ -{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"general": {"type": "family", "informations": {"paths": ["rougail.general"], "names": ["general"], "description": "général", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"varname": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.general.varname"], "names": ["varname"], "descriptions": ["No change."], "multiple": true}}}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["extra.var"], "names": ["var"], "descriptions": ["A varaible."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"extra.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"general": {"type": "family", "informations": {"paths": ["rougail.general"], "names": ["general"], "description": "général", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"varname": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.general.varname"], "names": ["varname"], "descriptions": ["No change."], "multiple": true}}}}}, "extra": {"type": "namespace", "informations": {"paths": ["extra"], "names": ["extra"], "description": "extra", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": ["a"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["extra.var"], "names": ["var"], "descriptions": ["A varaible."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["extra.dyn_a"], "names": ["dyn_a"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"extra.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["extra.dyn_a.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/docs/base/60_9extra_dynamic_extra.sh b/tests/docs/base/60_9extra_dynamic_extra.sh new file mode 100644 index 0000000..551d7a9 --- /dev/null +++ b/tests/docs/base/60_9extra_dynamic_extra.sh @@ -0,0 +1,75 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + description: général + varname: + type: string + description: No change + multi: true + default: + - a +version: '1.0' +``` +# dictionaries/extra/00-base.yml + +```yaml +--- +version: '1.1' +var: # a varaible + - a +dyn_{{ identifier }}: + dynamic: + variable: _.var + var: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + général + +standard + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.varname + string standard mandatory unique multiple No change. + Default: a + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.var + string standard mandatory unique multiple A varaible. + Default: a + + + + extra.dyn_a + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "extra.var". + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.dyn_a.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_9family_dynamic_calc_both.sh b/tests/docs/base/60_9family_dynamic_calc_both.sh new file mode 100644 index 0000000..243d94d --- /dev/null +++ b/tests/docs/base/60_9family_dynamic_calc_both.sh @@ -0,0 +1,48 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: val2 # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - variable: _.var + vardyn: # a dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A suffix variable. + Default: val2 + + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • the value of the variable "rougail.var". + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/68_0family_leadership_mode.sh b/tests/docs/base/68_0family_leadership_mode.sh new file mode 100644 index 0000000..e55447f --- /dev/null +++ b/tests/docs/base/68_0family_leadership_mode.sh @@ -0,0 +1,43 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic unique multiple A leader. + rougail.leader.follower1 + string standard A follower1. + rougail.leader.follower2 + string basic mandatory A follower2. + diff --git a/tests/docs/no_namespace/00_0empty.sh b/tests/docs/no_namespace/00_0empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/no_namespace/00_0version_underscore.sh b/tests/docs/no_namespace/00_0version_underscore.sh new file mode 100644 index 0000000..2ded863 --- /dev/null +++ b/tests/docs/no_namespace/00_0version_underscore.sh @@ -0,0 +1,18 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +_version: '1.1' +version: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + version + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/00_1empty_variable.sh b/tests/docs/no_namespace/00_1empty_variable.sh new file mode 100644 index 0000000..f49ddee --- /dev/null +++ b/tests/docs/no_namespace/00_1empty_variable.sh @@ -0,0 +1,18 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +empty: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + empty + string basic mandatory Empty. + diff --git a/tests/docs/no_namespace/00_2default_calculated.sh b/tests/docs/no_namespace/00_2default_calculated.sh new file mode 100644 index 0000000..7d4386d --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated.sh @@ -0,0 +1,32 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + multi: true + default: + jinja: | + {{ _.var1 }} + description: the value of var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string standard mandatory unique multiple A second variable. + Default: the value of var1. + diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.sh b/tests/docs/no_namespace/00_2default_calculated_multi.sh new file mode 100644 index 0000000..4c6f3a5 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_multi.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: # a first variable + - no + - yes + - maybe +var2: + description: a second variable + multi: true + default: + jinja: | + {% for val in _.var1 %} + {{ val }} + {% endfor %} + description: the value of _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A first variable. + Default: + + + • no + • yes + • maybe + | | var2 string standard mandatory unique multiple + | A second variable. Default: the value of _.var1. + | diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.sh b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.sh new file mode 100644 index 0000000..e17916a --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                                   Description                                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + domainname basic mandatory unique multiple A first variable. + Validator: the domain name can be an IP + var2 + domainname standard mandatory unique multiple A second variable. + Validator: the domain name can be an IP + Default: the value of the variable "var1". + diff --git a/tests/docs/no_namespace/00_4load_subfolder.sh b/tests/docs/no_namespace/00_4load_subfolder.sh new file mode 100644 index 0000000..a17827d --- /dev/null +++ b/tests/docs/no_namespace/00_4load_subfolder.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/99-base.yml + +```yaml +--- +version: '1.0' +var1: + description: a variable +``` +# dictionaries/rougail2/00-base.yml + +```yaml +--- +version: '1.0' +var2: + description: a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A variable. + var2 + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/00_5load_notype.sh b/tests/docs/no_namespace/00_5load_notype.sh new file mode 100644 index 0000000..1ff4e47 --- /dev/null +++ b/tests/docs/no_namespace/00_5load_notype.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +without_type: + description: a variable + default: non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + without_type + string standard mandatory A variable. + Default: non + diff --git a/tests/docs/no_namespace/00_6boolean.sh b/tests/docs/no_namespace/00_6boolean.sh new file mode 100644 index 0000000..cbf6a83 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: true # the first variable +var2: + description: the second variable + default: true +var3: + description: the third variable + type: boolean + default: true +var4: false # the forth variable +var5: + description: the fifth variable + default: false +var6: + description: the sixth variable + type: boolean + default: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + boolean standard mandatory The first variable. + Default: true + var2 + boolean standard mandatory The second variable. + Default: true + var3 + boolean standard mandatory The third variable. + Default: true + var4 + boolean standard mandatory The forth variable. + Default: false + var5 + boolean standard mandatory The fifth variable. + Default: false + var6 + boolean standard mandatory The sixth variable. + Default: false + diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.sh b/tests/docs/no_namespace/00_6boolean_no_mandatory.sh new file mode 100644 index 0000000..3784fc0 --- /dev/null +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + type: boolean + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                Description            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + boolean standard A variable. + Default: true + diff --git a/tests/docs/no_namespace/00_6choice.sh b/tests/docs/no_namespace/00_6choice.sh new file mode 100644 index 0000000..660d3ca --- /dev/null +++ b/tests/docs/no_namespace/00_6choice.sh @@ -0,0 +1,84 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the first variable + choices: + - a + - b + - c +var2: + description: the second variable + choices: + - a + - b + - c +var3: + description: the third variable + choices: + - a + - b + - c + mandatory: false +var4: + description: the forth variable + choices: + - + - b + - c + mandatory: false +var5: + description: the fifth variable + choices: + - a + - b + - c + default: a +var6: + description: the sixth variable + choices: + - 1 + - 2 + - 3 + default: 1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + choice basic mandatory The first variable. + Choices: + + + • a + • b + • c | | var2 choice basic mandatory + | The second variable. Choices: + • a + • b + • c | | var3 choice standard + | The third variable. Choices: + • a + • b + • c + • null | | var4 choice standard + | The forth variable. Choices: + • null + • b + • c | | var5 choice standard mandatory + | The fifth variable. Choices: + • a ← (default) + • b + • c | | var6 choice standard mandatory + | The sixth variable. Choices: + • 1 ← (default) + • 2 + • 3 | diff --git a/tests/docs/no_namespace/00_6choice_calculation.sh b/tests/docs/no_namespace/00_6choice_calculation.sh new file mode 100644 index 0000000..4d28db5 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_calculation.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + default: 9 + choices: + jinja: | + {% for n in trange(0, 10) %} + {{ n }} + {% endfor %} + return_type: number + description: choices is 0 to 9 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A variable. + Choices: choices is 0 to 9. + Default: 9 + diff --git a/tests/docs/no_namespace/00_6choice_variable.sh b/tests/docs/no_namespace/00_6choice_variable.sh new file mode 100644 index 0000000..2fc9991 --- /dev/null +++ b/tests/docs/no_namespace/00_6choice_variable.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a second variable + - a + - b + - c +var2: + description: a first variable + default: a + choices: + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A second variable. + Default: + + + • a + • b + • c + | | var2 choice standard mandatory + | A first variable. Choices: the value of the variable "var1". Default: a + | diff --git a/tests/docs/no_namespace/00_6custom.sh b/tests/docs/no_namespace/00_6custom.sh new file mode 100644 index 0000000..ea8938f --- /dev/null +++ b/tests/docs/no_namespace/00_6custom.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: the first variable + type: custom +custom2: + description: the seconf variable + type: custom + default: value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + custom1 + custom basic mandatory The first variable. + custom2 + custom standard mandatory The seconf variable. + Default: value + diff --git a/tests/docs/no_namespace/00_6domainname.sh b/tests/docs/no_namespace/00_6domainname.sh new file mode 100644 index 0000000..1ba8f95 --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + domainname standard mandatory A domain name variable. + Default: my.domain.name + diff --git a/tests/docs/no_namespace/00_6domainname_params.sh b/tests/docs/no_namespace/00_6domainname_params.sh new file mode 100644 index 0000000..9f2ecbe --- /dev/null +++ b/tests/docs/no_namespace/00_6domainname_params.sh @@ -0,0 +1,27 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a domain name variable + type: domainname + default: my.domain.name + params: + allow_ip: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                       Description                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + domainname standard mandatory A domain name variable. + Validator: the domain name can be an IP + Default: my.domain.name + diff --git a/tests/docs/no_namespace/00_6float.sh b/tests/docs/no_namespace/00_6float.sh new file mode 100644 index 0000000..227c024 --- /dev/null +++ b/tests/docs/no_namespace/00_6float.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0.0 # the first variable +var2: + description: the second variable + default: 0.0 +var3: + description: the third variable + type: float + default: 0.0 +var4: 10.1 # the forth variable +var5: + description: the fifth variable + default: 10.1 +var6: + description: the sixth variable + type: float + default: 10.1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                          Description                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + float standard mandatory The first variable. + Default: 0.0 + var2 + float standard mandatory The second variable. + Default: 0.0 + var3 + float standard mandatory The third variable. + Default: 0.0 + var4 + float standard mandatory The forth variable. + Default: 10.1 + var5 + float standard mandatory The fifth variable. + Default: 10.1 + var6 + float standard mandatory The sixth variable. + Default: 10.1 + diff --git a/tests/docs/no_namespace/00_6number.sh b/tests/docs/no_namespace/00_6number.sh new file mode 100644 index 0000000..1218fbc --- /dev/null +++ b/tests/docs/no_namespace/00_6number.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: 0 # the first variable +var2: + description: the second variable + default: 0 +var3: + description: the third variable + type: number + default: 0 +var4: 10 # this forth variable +var5: + description: the fifth variable + default: 10 +var6: + description: the sixth variable + type: number + default: 10 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + number standard mandatory The first variable. + Default: 0 + var2 + number standard mandatory The second variable. + Default: 0 + var3 + number standard mandatory The third variable. + Default: 0 + var4 + number standard mandatory This forth variable. + Default: 10 + var5 + number standard mandatory The fifth variable. + Default: 10 + var6 + number standard mandatory The sixth variable. + Default: 10 + diff --git a/tests/docs/no_namespace/00_6port.sh b/tests/docs/no_namespace/00_6port.sh new file mode 100644 index 0000000..41f2c9d --- /dev/null +++ b/tests/docs/no_namespace/00_6port.sh @@ -0,0 +1,38 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                       Description                                   + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + port basic mandatory A port variable. + variable2 + port standard mandatory A port variable with default value. + Default: 8080 + variable3 + port standard mandatory A port variable with integer default value. + Default: 8080 + diff --git a/tests/docs/no_namespace/00_6regexp.sh b/tests/docs/no_namespace/00_6regexp.sh new file mode 100644 index 0000000..b2b41c7 --- /dev/null +++ b/tests/docs/no_namespace/00_6regexp.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                                        Description                                                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + regexp standard mandatory A first variable. + Validator: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" + Default: #a1a1a1 + Examples: + + + • #b1b1b1 + • #b2b2b2 + | diff --git a/tests/docs/no_namespace/00_6string.sh b/tests/docs/no_namespace/00_6string.sh new file mode 100644 index 0000000..8eee578 --- /dev/null +++ b/tests/docs/no_namespace/00_6string.sh @@ -0,0 +1,53 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable +var2: + description: the second variable + default: +var3: + description: the third variable + type: string +var4: value # the forth variable +var5: + description: the fifth variable + default: value +var6: + description: the sixth variable + type: string + default: value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + var2 + string basic mandatory The second variable. + var3 + string basic mandatory The third variable. + var4 + string standard mandatory The forth variable. + Default: value + var5 + string standard mandatory The fifth variable. + Default: value + var6 + string standard mandatory The sixth variable. + Default: value + diff --git a/tests/docs/no_namespace/00_7choice_quote.sh b/tests/docs/no_namespace/00_7choice_quote.sh new file mode 100644 index 0000000..168a29c --- /dev/null +++ b/tests/docs/no_namespace/00_7choice_quote.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: quote' + choices: + - quote' + - quote" + - quote"' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A choice. + Choices: + + + • quote' ← (default) + • quote" + • quote"' | diff --git a/tests/docs/no_namespace/00_7help_quote.sh b/tests/docs/no_namespace/00_7help_quote.sh new file mode 100644 index 0000000..edb2852 --- /dev/null +++ b/tests/docs/no_namespace/00_7help_quote.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var1: + description: the first variable + help: message with ' +var2: + description: the second variable + help: message with " +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + Message with '. + var2 + string basic mandatory The second variable. + Message with ". + diff --git a/tests/docs/no_namespace/00_7value_doublequote.sh b/tests/docs/no_namespace/00_7value_doublequote.sh new file mode 100644 index 0000000..55eba60 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote" + diff --git a/tests/docs/no_namespace/00_7value_doublequote2.sh b/tests/docs/no_namespace/00_7value_doublequote2.sh new file mode 100644 index 0000000..ba3ca0d --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote2.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: quote'" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote'" + diff --git a/tests/docs/no_namespace/00_7value_doublequote3.sh b/tests/docs/no_namespace/00_7value_doublequote3.sh new file mode 100644 index 0000000..34a306e --- /dev/null +++ b/tests/docs/no_namespace/00_7value_doublequote3.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: quote\"\' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote"' + diff --git a/tests/docs/no_namespace/00_7value_quote.sh b/tests/docs/no_namespace/00_7value_quote.sh new file mode 100644 index 0000000..7571420 --- /dev/null +++ b/tests/docs/no_namespace/00_7value_quote.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +variable: + description: a variable + default: quote' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote' + diff --git a/tests/docs/no_namespace/00_8calculation_information.sh b/tests/docs/no_namespace/00_8calculation_information.sh new file mode 100644 index 0000000..9daa6b3 --- /dev/null +++ b/tests/docs/no_namespace/00_8calculation_information.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                          Description                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: get information test_information. + diff --git a/tests/docs/no_namespace/00_8test.sh b/tests/docs/no_namespace/00_8test.sh new file mode 100644 index 0000000..53a1368 --- /dev/null +++ b/tests/docs/no_namespace/00_8test.sh @@ -0,0 +1,84 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: the first variable + test: + - test + +var2: + description: the second variable + test: + - test + default: value + +var3: + description: the third variable + test: + - test1 + - test2 + +var4: + description: the forth variable + test: + - + - test1 + - test2 + mandatory: false + +var5: + description: the fifth variable + type: boolean + test: + - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + Example: test + var2 + string standard mandatory The second variable. + Default: value + Example: test + var3 + string basic mandatory The third variable. + Examples: + + + • test1 + • test2 + | | var4 string standard + | The forth variable. Examples: + • null + • test1 + • test2 + | | var5 boolean standard mandatory + | The fifth variable. Default: true Example: false + | | var6 string basic mandatory unique multiple + | The sixth variable. Examples: + • test1 + • test2 + | diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.sh b/tests/docs/no_namespace/00_9choice_variable_multi.sh new file mode 100644 index 0000000..70fdade --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variable_multi.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a first variable + type: choice + multi: true + choices: + - val1 + - val2 +variable2: + description: a second variable + type: choice + multi: true + mandatory: false + choices: + - val1 + - val2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + choice basic mandatory unique multiple A first variable. + Choices: + + + • val1 + • val2 + | | variable2 choice standard unique multiple + | A second variable. Choices: + • val1 + • val2 + | diff --git a/tests/docs/no_namespace/00_9choice_variables.sh b/tests/docs/no_namespace/00_9choice_variables.sh new file mode 100644 index 0000000..6675102 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variables.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +source_variable_1: val1 # the first source variable +source_variable_2: val2 # the second source variable +my_variable: + description: a variable + type: choice + choices: + - variable: _.source_variable_1 + - variable: _.source_variable_2 + default: val1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + source_variable_1 + string standard mandatory The first source variable. + Default: val1 + source_variable_2 + string standard mandatory The second source variable. + Default: val2 + my_variable + choice standard mandatory A variable. + Choices: + + + • the value of the variable "source_variable_1". + • the value of the variable "source_variable_2". Default: val1 + | diff --git a/tests/docs/no_namespace/00_9default_calculation.sh b/tests/docs/no_namespace/00_9default_calculation.sh new file mode 100644 index 0000000..4445d2d --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +variable: + description: a variable + default: + jinja: | + {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} + params: + param1: string + param2: 1 + param3: true + param4: + description: concat all parameters +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: concat all parameters. + diff --git a/tests/docs/no_namespace/00_9default_calculation_information.sh b/tests/docs/no_namespace/00_9default_calculation_information.sh new file mode 100644 index 0000000..b9fef5a --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: + jinja: '{{ information }}' + params: + information: + type: information + information: test_information + variable: _.var + description: returns the information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                 Description                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A variable. + Default: returns the information. + diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.sh b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.sh new file mode 100644 index 0000000..468bb5c --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + jinja: | + {{ information }} + params: + information: + type: information + information: test_information + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                  Description                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A first variable. + var2 + string standard mandatory A second variable. + Default: depends on a calculation. + diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.sh b/tests/docs/no_namespace/00_9default_calculation_multi_optional.sh new file mode 100644 index 0000000..0c311c3 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                 Description                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory My_variable. + Default: val1 + my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + Default: the value of the variable "my_variable". + diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.sh b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.sh new file mode 100644 index 0000000..df565bb --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                 Description                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory My_variable. + Default: val1 + my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + Default: the value of the variable "my_variable". + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.sh b/tests/docs/no_namespace/00_9default_calculation_optional.sh new file mode 100644 index 0000000..da1f959 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional.sh @@ -0,0 +1,22 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_calculated_variable + string standard mandatory unique multiple My_calculated_variable. + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.sh b/tests/docs/no_namespace/00_9default_calculation_optional_exists.sh new file mode 100644 index 0000000..acfc21e --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                                 Description                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory unique multiple My_variable. + Default: + + + • val1 + • val2 + | | my_calculated_variable string standard mandatory unique multiple + | My_calculated_variable. Default: the value of the variable "my_variable". + | diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.sh b/tests/docs/no_namespace/00_9default_calculation_param_optional.sh new file mode 100644 index 0000000..d51758b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + default: + jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 + }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' + params: + var2: + variable: _.var2 + optional: true + var3: + variable: _.var3 + optional: true + var4: + variable: _.unknown_family.var + optional: true + description: returns a value + mandatory: false +var2: no # a second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard A first variable. + Default: returns a value. + var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.sh b/tests/docs/no_namespace/00_9default_information_other_variable.sh new file mode 100644 index 0000000..c42ab68 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_information_other_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a first variable +var2: + description: a second variable + default: + type: information + information: test_information + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                                                                Description                                                                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A first variable. + var2 + string standard mandatory A second variable. + Default: the value of the information "test_information" of the variable "var1". + diff --git a/tests/docs/no_namespace/00_9default_integer.sh b/tests/docs/no_namespace/00_9default_integer.sh new file mode 100644 index 0000000..9760b92 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_integer.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a variable + default: 9 + choices: + jinja: | + {% for item in trange(0, 10) %} + {{ item }} + {%- endfor %} + return_type: number + description: choice for 0 to 9 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A variable. + Choices: choice for 0 to 9. + Default: 9 + diff --git a/tests/docs/no_namespace/01_6boolean_multi.sh b/tests/docs/no_namespace/01_6boolean_multi.sh new file mode 100644 index 0000000..6514a22 --- /dev/null +++ b/tests/docs/no_namespace/01_6boolean_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - true +var2: + description: the second variable + default: + - true +var3: + description: the third variable + type: boolean + default: + - true +var4: # the forth variable + - false +var5: + description: the fifth variable + default: + - false +var6: + description: the sixth variable + type: boolean + default: + - false + +var7: + description: the seventh variable + multi: true + default: + - true +var8: + description: the eighth variable + type: boolean + multi: true + default: + - true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                                Description                                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + boolean standard mandatory unique multiple The first variable. + Default: true + var2 + boolean standard mandatory unique multiple The second variable. + Default: true + var3 + boolean standard mandatory unique multiple The third variable. + Default: true + var4 + boolean standard mandatory unique multiple The forth variable. + Default: false + var5 + boolean standard mandatory unique multiple The fifth variable. + Default: false + var6 + boolean standard mandatory unique multiple The sixth variable. + Default: false + var7 + boolean standard mandatory unique multiple The seventh variable. + Default: true + var8 + boolean standard mandatory unique multiple The eighth variable. + Default: true + diff --git a/tests/docs/no_namespace/01_6custom_multi.sh b/tests/docs/no_namespace/01_6custom_multi.sh new file mode 100644 index 0000000..8d374ee --- /dev/null +++ b/tests/docs/no_namespace/01_6custom_multi.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +custom1: + description: a first custom variable + type: custom + multi: true +custom2: + description: a second custom variable + type: custom + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + custom1 + custom basic mandatory unique multiple A first custom variable. + custom2 + custom standard mandatory unique multiple A second custom variable. + Default: value + diff --git a/tests/docs/no_namespace/01_6float_multi.sh b/tests/docs/no_namespace/01_6float_multi.sh new file mode 100644 index 0000000..e7a9eba --- /dev/null +++ b/tests/docs/no_namespace/01_6float_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0.0 +var2: + description: the second variable + default: + - 0.0 +var3: + description: the third variable + type: float + default: + - 0.0 +var4: # the forth variable + - 10.1 +var5: + description: the fifth variable + default: + - 10.1 +var6: + description: the sixth variable + type: float + default: + - 10.1 + +var7: + description: the seventh variable + multi: true + default: + - 0.0 +var8: + description: the eighth variable + type: float + multi: true + default: + - 0.0 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                              Description                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + float standard mandatory unique multiple The first variable. + Default: 0.0 + var2 + float standard mandatory unique multiple The second variable. + Default: 0.0 + var3 + float standard mandatory unique multiple The third variable. + Default: 0.0 + var4 + float standard mandatory unique multiple The forth variable. + Default: 10.1 + var5 + float standard mandatory unique multiple The fifth variable. + Default: 10.1 + var6 + float standard mandatory unique multiple The sixth variable. + Default: 10.1 + var7 + float standard mandatory unique multiple The seventh variable. + Default: 0.0 + var8 + float standard mandatory unique multiple The eighth variable. + Default: 0.0 + diff --git a/tests/docs/no_namespace/01_6number_multi.sh b/tests/docs/no_namespace/01_6number_multi.sh new file mode 100644 index 0000000..c4bc189 --- /dev/null +++ b/tests/docs/no_namespace/01_6number_multi.sh @@ -0,0 +1,88 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # the first variable + - 0 +var2: + description: the second variable + default: + - 0 +var3: + description: the third variable + type: number + default: + - 0 +var4: # the forth variable + - 10 +var5: + description: the fifth variable + default: + - 10 +var6: + description: the sixth variable + type: number + default: + - 10 + +var7: + description: the seventh variable + multi: true + default: + - 0 +var8: + description: the eighth variable + type: number + multi: true + default: + - 0 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + number standard mandatory unique multiple The first variable. + Default: 0 + var2 + number standard mandatory unique multiple The second variable. + Default: 0 + var3 + number standard mandatory unique multiple The third variable. + Default: 0 + var4 + number standard mandatory unique multiple The forth variable. + Default: 10 + var5 + number standard mandatory unique multiple The fifth variable. + Default: 10 + var6 + number standard mandatory unique multiple The sixth variable. + Default: 10 + var7 + number standard mandatory unique multiple The seventh variable. + Default: 0 + var8 + number standard mandatory unique multiple The eighth variable. + Default: 0 + diff --git a/tests/docs/no_namespace/01_6string_empty.sh b/tests/docs/no_namespace/01_6string_empty.sh new file mode 100644 index 0000000..1915d2a --- /dev/null +++ b/tests/docs/no_namespace/01_6string_empty.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the second variable + empty: false + default: + - value + - +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple The second variable. + Default: + + + • value + • null + | diff --git a/tests/docs/no_namespace/01_6string_multi.sh b/tests/docs/no_namespace/01_6string_multi.sh new file mode 100644 index 0000000..d9980f3 --- /dev/null +++ b/tests/docs/no_namespace/01_6string_multi.sh @@ -0,0 +1,78 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: [] # the first variable +var2: + description: the second variable + default: [] +var3: + description: the third variable + type: string +var4: # the forth variable + - value +var5: + description: the fifth variable + default: + - value +var6: + description: the sixth variable + type: string + default: + - value + +var7: + description: the seventh variable + multi: true + default: + - value +var8: + description: the eighth variable + type: string + multi: true + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory unique multiple The first variable. + var2 + string basic mandatory unique multiple The second variable. + var3 + string basic mandatory The third variable. + var4 + string standard mandatory unique multiple The forth variable. + Default: value + var5 + string standard mandatory unique multiple The fifth variable. + Default: value + var6 + string standard mandatory unique multiple The sixth variable. + Default: value + var7 + string standard mandatory unique multiple The seventh variable. + Default: value + var8 + string standard mandatory unique multiple The eighth variable. + Default: value + diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.sh b/tests/docs/no_namespace/01_7value_multi_doublequote.sh new file mode 100644 index 0000000..c30cfc5 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: quote" + diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.sh b/tests/docs/no_namespace/01_7value_multi_doublequote2.sh new file mode 100644 index 0000000..82ce4fe --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote'" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: quote'" + diff --git a/tests/docs/no_namespace/01_7value_multi_quote.sh b/tests/docs/no_namespace/01_7value_multi_quote.sh new file mode 100644 index 0000000..cab2f99 --- /dev/null +++ b/tests/docs/no_namespace/01_7value_multi_quote.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + - quote' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: quote' + diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.sh b/tests/docs/no_namespace/01_8calculation_information_multi.sh new file mode 100644 index 0000000..241ee3c --- /dev/null +++ b/tests/docs/no_namespace/01_8calculation_information_multi.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + multi: true + default: + jinja: | + {{test_information }} + params: + test_information: + type: information + information: test_information + description: get information test_information +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: get information test_information. + diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.sh b/tests/docs/no_namespace/01_9choice_variable_multi.sh new file mode 100644 index 0000000..137cb44 --- /dev/null +++ b/tests/docs/no_namespace/01_9choice_variable_multi.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: # a first variable + - a + - b + - c +variable2: + description: a second variable + choices: + variable: _.variable1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + string standard mandatory unique multiple A first variable. + Default: + + + • a + • b + • c + | | variable2 choice basic mandatory + | A second variable. Choices: the value of the variable "variable1". + | diff --git a/tests/docs/no_namespace/04_0type_param.sh b/tests/docs/no_namespace/04_0type_param.sh new file mode 100644 index 0000000..fe475a5 --- /dev/null +++ b/tests/docs/no_namespace/04_0type_param.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A limited number + default: 10 + params: + min_number: 0 + max_number: 100 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + int + number standard mandatory A limited number. + Validators: + + + • the minimum value is 0 + • the maximum value is 100 Default: 10 | diff --git a/tests/docs/no_namespace/04_1auto_save.sh b/tests/docs/no_namespace/04_1auto_save.sh new file mode 100644 index 0000000..2c962eb --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save.sh @@ -0,0 +1,23 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +variable: + description: an auto save variable + auto_save: true + default: no +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                        Description                                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory auto modified An auto save variable. + Default: no + diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.sh b/tests/docs/no_namespace/04_1auto_save_and_calculated.sh new file mode 100644 index 0000000..2117256 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: no # a first variable +var2: + description: a second variable + auto_save: true + default: + variable: _.var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                          Description                                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string basic mandatory auto modified A second variable. + Default: the value of the variable "var1". + diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.sh b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.sh new file mode 100644 index 0000000..240e0c1 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + auto_save: true + hidden: + jinja: | + {% if _.var1 == "yes" %} + _.var1 is yes + {% endif %} + description: only if the variable var1 has value "yes" + default: + jinja: yes + description: the value is always yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                                                   Description                                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string basic mandatory hidden auto modified A second variable. + Default: the value is always yes. + Hidden: only if the variable var1 has value "yes". + diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.sh b/tests/docs/no_namespace/04_1auto_save_and_hidden.sh new file mode 100644 index 0000000..4443d01 --- /dev/null +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.sh @@ -0,0 +1,12 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: autosave variable + auto_save: true + hidden: true + default: yes + mandatory: false +``` diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.sh b/tests/docs/no_namespace/04_1default_calculation_hidden.sh new file mode 100644 index 0000000..9414fa4 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: value + var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "var1" has the value "value". + var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.sh b/tests/docs/no_namespace/04_1default_calculation_hidden_2.sh new file mode 100644 index 0000000..177f6bf --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: value + var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "var1" has the value "value". + var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.sh b/tests/docs/no_namespace/04_5disabled_calculation_optional.sh new file mode 100644 index 0000000..1726fd4 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var1: + description: a first variable + hidden: + jinja: | + {% if unknown is not defined %} + unknown is undefined + {% elif unknown == "no" %} + unknown is no + {% endif %} + params: + unknown: + variable: _.unknown + optional: true + description: calculation from an unknown variable + mandatory: false +var2: + description: a second variable + hidden: + jinja: | + {% if condition is not defined %} + condition is undefined + {% elif condition == "no" %} + condition is no + {% endif %} + params: + condition: + variable: _.condition + optional: true + description: calculation from an condition variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + var1 + string standard hidden A first variable. + Hidden: calculation from an unknown variable. + var2 + string standard hidden A second variable. + Hidden: calculation from an condition variable. + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.sh b/tests/docs/no_namespace/04_5disabled_calculation_variable.sh new file mode 100644 index 0000000..63bce7e --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: false # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                             Description                                                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: false + variable + string basic mandatory disabled A variable. + Disabled: when the variable "condition" has the value "true". + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.sh b/tests/docs/no_namespace/04_5disabled_calculation_variable2.sh new file mode 100644 index 0000000..0a87954 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +variable: + description: a variable + disabled: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                             Description                                                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: true + variable + string basic mandatory disabled A variable. + Disabled: when the variable "condition" has the value "true". + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.sh b/tests/docs/no_namespace/04_5disabled_calculation_variable3.sh new file mode 100644 index 0000000..b52d7e9 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                            Description                                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + variable + string basic mandatory disabled A variable. + Disabled: when the variable "condition" has the value "yes". + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.sh b/tests/docs/no_namespace/04_5disabled_calculation_variable4.sh new file mode 100644 index 0000000..38b6373 --- /dev/null +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +variable: + description: a variable + disabled: + variable: _.condition + when_not: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                               Description                                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + variable + string basic mandatory disabled A variable. + Disabled: when the variable "condition" hasn't the value "yes". + diff --git a/tests/docs/no_namespace/04_5validators.sh b/tests/docs/no_namespace/04_5validators.sh new file mode 100644 index 0000000..2223cfc --- /dev/null +++ b/tests/docs/no_namespace/04_5validators.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +int: + description: A number + type: number + validators: + - jinja: | + {% if _.int > 100 %} + value is too high + {% endif %} + description: the max value is 100 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + int + number basic mandatory A number. + Validator: the max value is 100. + diff --git a/tests/docs/no_namespace/04_5validators_differ.sh b/tests/docs/no_namespace/04_5validators_differ.sh new file mode 100644 index 0000000..9e68f96 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_differ.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + test: + - another_value + type: string + default: oui + validators: + - jinja: | + {% if _.var1 == _.var2 %} + var1 must be different than var2 + {% endif %} + description: var1 must be different than var2 +var2: no # A second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Validator: var1 must be different than var2. + Default: oui + Example: another_value + var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/docs/no_namespace/04_5validators_multi.sh b/tests/docs/no_namespace/04_5validators_multi.sh new file mode 100644 index 0000000..367265f --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A second variable. + Validator: check length is less than 10. + Default: + + + • no + • yes + | diff --git a/tests/docs/no_namespace/04_5validators_multi2.sh b/tests/docs/no_namespace/04_5validators_multi2.sh new file mode 100644 index 0000000..4b0398f --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi2.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A second variable. + Validator: check length is less than 3. + Default: + + + • no + • yes Examples: + • val1 + • val2 + | diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.sh b/tests/docs/no_namespace/05_0multi_not_uniq.sh new file mode 100644 index 0000000..a1a5d45 --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_not_uniq.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a variable + unique: false + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                      Description                                  + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory multiple A variable. + Default: non + diff --git a/tests/docs/no_namespace/05_0multi_uniq.sh b/tests/docs/no_namespace/05_0multi_uniq.sh new file mode 100644 index 0000000..9dc931a --- /dev/null +++ b/tests/docs/no_namespace/05_0multi_uniq.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + unique: true + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: non + diff --git a/tests/docs/no_namespace/12_1auto_save_expert.sh b/tests/docs/no_namespace/12_1auto_save_expert.sh new file mode 100644 index 0000000..c6d92a9 --- /dev/null +++ b/tests/docs/no_namespace/12_1auto_save_expert.sh @@ -0,0 +1,11 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var: + description: a variable + auto_save: true + mode: advanced + default: no +``` diff --git a/tests/docs/no_namespace/16_0redefine_description.sh b/tests/docs/no_namespace/16_0redefine_description.sh new file mode 100644 index 0000000..d9d5436 --- /dev/null +++ b/tests/docs/no_namespace/16_0redefine_description.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Redefine description +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +var: + description: Redefined + redefine: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory Redefined. + diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.sh b/tests/docs/no_namespace/16_2family_redefine_calculation.sh new file mode 100644 index 0000000..44e3918 --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: + jinja: | + true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + family + +basic disabled + +Disabled: depends on a calculation. + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory Var1. + diff --git a/tests/docs/no_namespace/16_2family_redefine_disabled.sh b/tests/docs/no_namespace/16_2family_redefine_disabled.sh new file mode 100644 index 0000000..1bd1240 --- /dev/null +++ b/tests/docs/no_namespace/16_2family_redefine_disabled.sh @@ -0,0 +1,17 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +family: + redefine: true + disabled: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +family: + var1: +``` diff --git a/tests/docs/no_namespace/16_5exists_nonexists.sh b/tests/docs/no_namespace/16_5exists_nonexists.sh new file mode 100644 index 0000000..8866ca4 --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_nonexists.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var2: + description: a new variable + exists: false + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A variable. + Default: no + var2 + string standard mandatory A new variable. + Default: yes + diff --git a/tests/docs/no_namespace/16_5exists_redefine.sh b/tests/docs/no_namespace/16_5exists_redefine.sh new file mode 100644 index 0000000..cbebb4d --- /dev/null +++ b/tests/docs/no_namespace/16_5exists_redefine.sh @@ -0,0 +1,26 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + exists: true + default: yes +var2: + description: a second variable + redefine: true + exists: true + default: yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a first variable + hidden: true + default: no + mandatory: false +``` diff --git a/tests/docs/no_namespace/16_5redefine_calculation.sh b/tests/docs/no_namespace/16_5redefine_calculation.sh new file mode 100644 index 0000000..62976a6 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_calculation.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: + jinja: yes + description: returns yes +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: no + description: returns no +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: returns yes. + diff --git a/tests/docs/no_namespace/16_5redefine_choice.sh b/tests/docs/no_namespace/16_5redefine_choice.sh new file mode 100644 index 0000000..ec17576 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_choice.sh @@ -0,0 +1,39 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + choices: + - a + - b + - c +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.0' +variable: + redefine: true + choices: + - a + - b +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + choice basic mandatory A variable. + Choices: + + + • a + • b | diff --git a/tests/docs/no_namespace/16_5redefine_default.sh b/tests/docs/no_namespace/16_5redefine_default.sh new file mode 100644 index 0000000..74e579c --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: no +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: yes + diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.sh b/tests/docs/no_namespace/16_5redefine_default_calculation.sh new file mode 100644 index 0000000..74ca107 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + default: +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: + jinja: yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/16_5redefine_family.sh b/tests/docs/no_namespace/16_5redefine_family.sh new file mode 100644 index 0000000..fc03df8 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_family.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + variable: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/16_5redefine_help.sh b/tests/docs/no_namespace/16_5redefine_help.sh new file mode 100644 index 0000000..862e2a2 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_help.sh @@ -0,0 +1,44 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + help: redefine help family ok + variable: + redefine: true + help: redefine help ok +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + help: redefine help family + variable: + description: redefine help + help: redefine help +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + +Redefine help family ok. + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable + string basic mandatory Redefine help. + Redefine help ok. + diff --git a/tests/docs/no_namespace/16_5redefine_hidden.sh b/tests/docs/no_namespace/16_5redefine_hidden.sh new file mode 100644 index 0000000..8ea19b8 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_hidden.sh @@ -0,0 +1,17 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: no # a variable +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + hidden: true + mandatory: false +``` diff --git a/tests/docs/no_namespace/16_5redefine_multi.sh b/tests/docs/no_namespace/16_5redefine_multi.sh new file mode 100644 index 0000000..3415c06 --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_multi.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: + description: a variable + default: non +``` +# dictionaries/rougail/01-redefine.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + multi: true + default: + - non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique multiple A variable. + Default: non + diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.sh b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.sh new file mode 100644 index 0000000..3f8b42d --- /dev/null +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +variable: + redefine: true + disabled: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +variable: + description: a variable + disabled: + jinja: | + {% if _.condition == "yes" %} + true + {% else %} + false + {% endif %} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + variable + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/16_5test_redefine.sh b/tests/docs/no_namespace/16_5test_redefine.sh new file mode 100644 index 0000000..f574415 --- /dev/null +++ b/tests/docs/no_namespace/16_5test_redefine.sh @@ -0,0 +1,58 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: + description: a second variable + test: + - test + default: non +var3: + description: a third variable + test: + - test +``` +# dictionaries/rougail/10-base.yml + +```yaml +--- +version: '1.1' +var1: + redefine: true + test: + - test1 +var2: + redefine: true + test: + - test1 +var3: + redefine: true + test: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + Example: test1 + var2 + string standard mandatory A second variable. + Default: non + Example: test1 + var3 + string basic mandatory A third variable. + diff --git a/tests/docs/no_namespace/16_6choice_redefine.sh b/tests/docs/no_namespace/16_6choice_redefine.sh new file mode 100644 index 0000000..c441e37 --- /dev/null +++ b/tests/docs/no_namespace/16_6choice_redefine.sh @@ -0,0 +1,41 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.0' +var: + redefine: true + choices: + - a + - c +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + type: choice + description: A choice + default: c + choices: + - a + - b + - c +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A choice. + Choices: + + + • a + • c ← (default) | diff --git a/tests/docs/no_namespace/16exists_exists.sh b/tests/docs/no_namespace/16exists_exists.sh new file mode 100644 index 0000000..176d0b4 --- /dev/null +++ b/tests/docs/no_namespace/16exists_exists.sh @@ -0,0 +1,28 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var: + description: New description + exists: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: Description +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory Description. + diff --git a/tests/docs/no_namespace/17_5redefine_leadership.sh b/tests/docs/no_namespace/17_5redefine_leadership.sh new file mode 100644 index 0000000..ce9f7b3 --- /dev/null +++ b/tests/docs/no_namespace/17_5redefine_leadership.sh @@ -0,0 +1,24 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: # a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/no_namespace/20_0empty_family.sh b/tests/docs/no_namespace/20_0empty_family.sh new file mode 100644 index 0000000..cc79b77 --- /dev/null +++ b/tests/docs/no_namespace/20_0empty_family.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + type: family +``` diff --git a/tests/docs/no_namespace/20_0family_append.sh b/tests/docs/no_namespace/20_0family_append.sh new file mode 100644 index 0000000..6fe325a --- /dev/null +++ b/tests/docs/no_namespace/20_0family_append.sh @@ -0,0 +1,38 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + var2: + description: The second variable +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: A family + var1: + description: The first variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory The first variable. + family.var2 + string basic mandatory The second variable. + diff --git a/tests/docs/no_namespace/20_0family_underscore.sh b/tests/docs/no_namespace/20_0family_underscore.sh new file mode 100644 index 0000000..932db63 --- /dev/null +++ b/tests/docs/no_namespace/20_0family_underscore.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +my_family: + _type: family + _description: This is a great family + _help: This is a great family + _mode: standard + _hidden: true + _disabled: true + type: + description: a type family + type: family + my_variable: + mandatory: false + description: + description: This is a other great family + my_variable: + mandatory: false + help: + description: a help family + help: This is a other great family + my_variable: + mandatory: false + mode: + description: a mode family + mode: advanced + my_variable: + mandatory: false + hidden: + description: an hidden family + hidden: true + my_variable: + mandatory: false + disabled: + description: an disabled family + disabled: true + my_variable: + mandatory: false +``` diff --git a/tests/docs/no_namespace/20_0multi_family.sh b/tests/docs/no_namespace/20_0multi_family.sh new file mode 100644 index 0000000..a1f9385 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family.sh @@ -0,0 +1,31 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +standard + + a sub family + +standard + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string standard A variable. + diff --git a/tests/docs/no_namespace/20_0multi_family_basic.sh b/tests/docs/no_namespace/20_0multi_family_basic.sh new file mode 100644 index 0000000..5b0885d --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_basic.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + subfamily: # a sub family + variable: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + a sub family + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/20_0multi_family_expert.sh b/tests/docs/no_namespace/20_0multi_family_expert.sh new file mode 100644 index 0000000..daa11eb --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_expert.sh @@ -0,0 +1,13 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: + description: a family + mode: advanced + subfamily: # a sub family + variable: + description: a variable + mandatory: false +``` diff --git a/tests/docs/no_namespace/20_0multi_family_order.sh b/tests/docs/no_namespace/20_0multi_family_order.sh new file mode 100644 index 0000000..cf7b140 --- /dev/null +++ b/tests/docs/no_namespace/20_0multi_family_order.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable: # a variable +family: # a family + variable1: # a first variable + subfamily: # a sub family + variable: # a variable + variable2: # a second variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory A variable. + + + + a family + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable1 + string basic mandatory A first variable. + + + a sub family + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string basic mandatory A variable. + + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable2 + string basic mandatory A second variable. + diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.sh b/tests/docs/no_namespace/20_0validators_differ_redefine.sh new file mode 100644 index 0000000..3031a6d --- /dev/null +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +var3: + redefine: true + validators: + - jinja: | + {% if _.var3 == _.var2 %} + var3 must be different than var2 + {% endif %} + description: var3 must be different than var2 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: no # a first variable +var2: no # a second variable +var3: + description: a third variable + default: yes + test: + - yes + validators: + - jinja: | + {% if _.var3 == _.var1 %} + var3 must be different than var1 + {% endif %} + description: var3 must be different than var1 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string standard mandatory A second variable. + Default: no + var3 + string standard mandatory A third variable. + Validator: var3 must be different than var2. + Default: yes + Example: yes + diff --git a/tests/docs/no_namespace/20_1empty_subfamily.sh b/tests/docs/no_namespace/20_1empty_subfamily.sh new file mode 100644 index 0000000..7a52420 --- /dev/null +++ b/tests/docs/no_namespace/20_1empty_subfamily.sh @@ -0,0 +1,9 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +my_family: + my_sub_family: + type: family +``` diff --git a/tests/docs/no_namespace/20_9default_information_parent.sh b/tests/docs/no_namespace/20_9default_information_parent.sh new file mode 100644 index 0000000..840e851 --- /dev/null +++ b/tests/docs/no_namespace/20_9default_information_parent.sh @@ -0,0 +1,35 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +family: + var1: # a first variable + var2: + description: a second variable + default: + type: information + information: test_information + variable: __.family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + family + +basic + + + + + +  Variable                                                                                  Description                                                                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory A first variable. + family.var2 + string standard mandatory A second variable. + Default: the value of the information "test_information" of the variable "family". + diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.sh b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.sh new file mode 100644 index 0000000..c50887e --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.sh @@ -0,0 +1,49 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: if condition is yes + subfamily: + var1: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + family.subfamily + +basic + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.var1 + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.sh b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.sh new file mode 100644 index 0000000..cf51e24 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # the variable use has condition +family: + description: possibly hidden family + hidden: + variable: _.condition + subfamily: # a subfamily + var1: + description: a variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory The variable use has condition. + Default: true + + + + possibly hidden family + +standard hidden + +Hidden: when the variable "condition" has the value "true". + + a subfamily + +standard + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.var1 + string standard A variable. + diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.sh b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.sh new file mode 100644 index 0000000..b47934a --- /dev/null +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # the variable use has condition +family: + description: possibly hidden family + hidden: + jinja: | + {% if condition == "yes" %} + condition is yes + {% endif %} + params: + condition: + variable: _.condition + description: if condition is yes + sub_family: # a subfamily + var1: # a variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + a subfamily + +basic + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.sub_family.var1 + string basic mandatory A variable. + diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.sh b/tests/docs/no_namespace/24_0family_mandatory_condition.sh new file mode 100644 index 0000000..6910db6 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.sh @@ -0,0 +1,33 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +var: + description: a variable + mandatory: + jinja: | + {% if _.condition == "yes" %} + condition is yes + {% endif %} + description: only if rougail.condition has the value "yes" +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                         Description                                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + var + string standard mandatory A variable. + Mandatory: only if rougail.condition has the value "yes". + diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.sh b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.sh new file mode 100644 index 0000000..08fbbe0 --- /dev/null +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: true # a condition +var: + description: a variable + mandatory: + variable: _.condition +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                                              Description                                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: true + var + string standard mandatory A variable. + Mandatory: when the variable "condition" has the value "true". + diff --git a/tests/docs/no_namespace/24_7validators_variable_optional.sh b/tests/docs/no_namespace/24_7validators_variable_optional.sh new file mode 100644 index 0000000..aa616c9 --- /dev/null +++ b/tests/docs/no_namespace/24_7validators_variable_optional.sh @@ -0,0 +1,55 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +general: # a family + int: + description: a first number + type: number + test: + - 5 + validators: + - jinja: | + {% if _.int == int2 %} + int and int2 must be different + {% endif %} + params: + int2: + variable: _.int2 + optional: true + description: int and int2 must be different + - jinja: | + {% if int3 is defined and _.int == int3 %} + int and int3 must be different + {% endif %} + params: + int3: + variable: _.int3 + optional: true + description: int and int3 must be different + int2: 1 # a second number +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general.int + number basic mandatory A first number. + Validators: + + + • int and int2 must be different. + • int and int3 must be different. Example: 5 | | general.int2 number standard + mandatory | A second number. Default: 1 + | diff --git a/tests/docs/no_namespace/24_family_disabled_var_hidden.sh b/tests/docs/no_namespace/24_family_disabled_var_hidden.sh new file mode 100644 index 0000000..ea598d4 --- /dev/null +++ b/tests/docs/no_namespace/24_family_disabled_var_hidden.sh @@ -0,0 +1,16 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +``` diff --git a/tests/docs/no_namespace/40_0leadership.sh b/tests/docs/no_namespace/40_0leadership.sh new file mode 100644 index 0000000..831458c --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership.sh @@ -0,0 +1,36 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: # a follower + follower2: # an other follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique multiple A leader. + leader.follower1 + string basic mandatory A follower. + leader.follower2 + string basic mandatory An other follower. + diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.sh b/tests/docs/no_namespace/40_0leadership_diff_name.sh new file mode 100644 index 0000000..30e8efd --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_diff_name.sh @@ -0,0 +1,36 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leadership: + description: a leadership + type: leadership + leader: [] # a leader + follower1: # a follower + follower2: # an other follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leadership.leader + string basic mandatory unique multiple A leader. + leadership.follower1 + string basic mandatory A follower. + leadership.follower2 + string basic mandatory An other follower. + diff --git a/tests/docs/no_namespace/40_0leadership_empty.sh b/tests/docs/no_namespace/40_0leadership_empty.sh new file mode 100644 index 0000000..9ba2e94 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_empty.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +empty_leader: + type: leadership +``` diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.sh b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.sh new file mode 100644 index 0000000..140a29b --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.sh @@ -0,0 +1,45 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: # a leader + follower1: value # a follower + follower2: + description: a second follower + default: + jinja: | + {{ _.follower1 }} + description: returns follower1 value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique multiple A leader. + leader.follower1 + string standard mandatory A follower. + Default: value + leader.follower2 + string standard mandatory A second follower. + Default: returns follower1 value. + diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.sh b/tests/docs/no_namespace/40_0leadership_follower_default_value.sh new file mode 100644 index 0000000..75519f1 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower1: value # a follower with default value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower1 + string standard mandatory A follower with default value. + Default: value + diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.sh b/tests/docs/no_namespace/40_0leadership_leader_not_multi.sh new file mode 100644 index 0000000..565656f --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.sh @@ -0,0 +1,67 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + general + +standard + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general.mode_conteneur_actif + string standard mandatory No change. + Default: non + + + + general1 + +basic + + general1.leader + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general1.leader.leader + string basic mandatory unique multiple Leader. + general1.leader.follower1 + string basic mandatory Follower1. + general1.leader.follower2 + string basic mandatory Follower2. + diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.sh b/tests/docs/no_namespace/40_1leadership_append_follower.sh new file mode 100644 index 0000000..38c9dcb --- /dev/null +++ b/tests/docs/no_namespace/40_1leadership_append_follower.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: the follower3 +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: the leader + multi: true + follower1: + description: the follower1 + follower2: + description: the follower2 +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique multiple The leader. + leader.follower1 + string basic mandatory The follower1. + leader.follower2 + string basic mandatory The follower2. + leader.follower3 + string basic mandatory The follower3. + diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.sh b/tests/docs/no_namespace/40_6leadership_follower_multi.sh new file mode 100644 index 0000000..3fe6ad8 --- /dev/null +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leadership: + description: A leadership + type: leadership + leader: + description: The leader + multi: true + follower1: + description: The first follower + multi: true + follower2: + description: The second follower + multi: true + default: + - value +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leadership.leader + string basic mandatory unique multiple The leader. + leadership.follower1 + string basic mandatory multiple The first follower. + leadership.follower2 + string standard mandatory multiple The second follower. + Default: value + diff --git a/tests/docs/no_namespace/40_8calculation_boolean.sh b/tests/docs/no_namespace/40_8calculation_boolean.sh new file mode 100644 index 0000000..f280285 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_boolean.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +bool: false # a boolean variable +multi1: + description: a first multi variable + type: boolean + multi: true + default: + jinja: | + {% if _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +multi2: + description: a second multi variable + type: boolean + multi: true + default: + jinja: | + {% if not _.bool %} + True + False + {% else %} + False + {% endif %} + description: a calculation +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                                Description                                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + bool + boolean standard mandatory A boolean variable. + Default: false + multi1 + boolean standard mandatory unique multiple A first multi variable. + Default: a calculation. + multi2 + boolean standard mandatory unique multiple A second multi variable. + Default: a calculation. + diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.sh b/tests/docs/no_namespace/40_8calculation_multi_variable.sh new file mode 100644 index 0000000..37942db --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.sh @@ -0,0 +1,34 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + default: + - variable: _.var2 + - variable: _.var3 +var2: no # a second variable +var3: yes # a third variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A first variable. + Default: + + + • the value of the variable "var2". + • the value of the variable "var3". + | | var2 string standard mandatory + | A second variable. Default: no + | | var3 string standard mandatory + | A third variable. Default: yes + | diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.sh b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.sh new file mode 100644 index 0000000..e526d5e --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.sh @@ -0,0 +1,40 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: no # a variable +fam1: # a family + var: + description: a calculated variable + default: + variable: __.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A variable. + Default: no + + + + a family + +standard + + + + +  Variable                                         Description                                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam1.var + string standard mandatory A calculated variable. + Default: the value of the variable "var". + diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.sh b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.sh new file mode 100644 index 0000000..1b3cec5 --- /dev/null +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.sh @@ -0,0 +1,46 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +fam1: # first family + var: no # a variable +fam2: # second family + var: + description: a varaible + default: + variable: __.fam1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + first family + +standard + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam1.var + string standard mandatory A variable. + Default: no + + + + second family + +standard + + + + +  Variable                                              Description                                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam2.var + string standard mandatory A varaible. + Default: the value of the variable "fam1.var". + diff --git a/tests/docs/no_namespace/41_0choice_leader.sh b/tests/docs/no_namespace/41_0choice_leader.sh new file mode 100644 index 0000000..d0e683c --- /dev/null +++ b/tests/docs/no_namespace/41_0choice_leader.sh @@ -0,0 +1,47 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: The leadership + type: leadership + leader: + description: The leader + multi: true + mandatory: false + follower1: + type: choice + description: A follower + choices: + - a + - b + - c +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + The leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple The leader. + leader.follower1 + choice basic mandatory A follower. + Choices: + + + • a + • b + • c | diff --git a/tests/docs/no_namespace/44_0leadership_hidden.sh b/tests/docs/no_namespace/44_0leadership_hidden.sh new file mode 100644 index 0000000..8a12034 --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_hidden.sh @@ -0,0 +1,19 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + hidden: true + type: leadership + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.sh b/tests/docs/no_namespace/44_0leadership_leader_hidden.sh new file mode 100644 index 0000000..003b3f1 --- /dev/null +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.sh @@ -0,0 +1,20 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +leader: + description: a leadership + type: leadership + + leader: + description: a leader + multi: true + hidden: true + mandatory: false + + follower: + description: a follower + mandatory: false +``` diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.sh b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.sh new file mode 100644 index 0000000..ba8548b --- /dev/null +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.sh @@ -0,0 +1,30 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +leader: + follower3: + description: follower3 + mandatory: false +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: true + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false +``` diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.sh b/tests/docs/no_namespace/44_4leadership_mandatory.sh new file mode 100644 index 0000000..c6e89d7 --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: true + follower1: + description: a follower + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique multiple A leader. + leader.follower1 + string standard A follower. + diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.sh b/tests/docs/no_namespace/44_4leadership_mandatory_follower.sh new file mode 100644 index 0000000..33cbe52 --- /dev/null +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: true +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.sh b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.sh new file mode 100644 index 0000000..292be5e --- /dev/null +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: no # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + hidden: + jinja: | + {% if __.condition == "no" %} + condition is no + {% endif %} + description: if condition is no + mandatory: false + follower: # a follower +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + + + + a leadership + +basic hidden + +Hidden: if condition is no. + +This family contains lists of variable blocks. + + + + +  Variable                                   Description                               + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.sh b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.sh new file mode 100644 index 0000000..94471ba --- /dev/null +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +condition: yes # a condition +leader: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower: + description: a follower + disabled: + jinja: | + {% if __.condition == "yes" %} + disabled + {% endif %} + description: if condition is yes +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique multiple A leader. + leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/docs/no_namespace/60_0family_dynamic.sh b/tests/docs/no_namespace/60_0family_dynamic.sh new file mode 100644 index 0000000..e5152b3 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: # A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.sh b/tests/docs/no_namespace/60_0family_dynamic_1_1.sh new file mode 100644 index 0000000..05b842d --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.sh @@ -0,0 +1,51 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.vardyn + dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/docs/no_namespace/60_0family_dynamic_no_description.sh b/tests/docs/no_namespace/60_0family_dynamic_no_description.sh new file mode 100644 index 0000000..e055f49 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_no_description.sh @@ -0,0 +1,52 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: # A suffix variable + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory Var. + diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.sh b/tests/docs/no_namespace/60_0family_dynamic_static.sh new file mode 100644 index 0000000..bccd1fc --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_static.sh @@ -0,0 +1,37 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + var: # a variable inside a dynamic family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A variable inside a dynamic family. + diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.sh b/tests/docs/no_namespace/60_0family_dynamic_test.sh new file mode 100644 index 0000000..60b9f81 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_test.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.sh b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.sh new file mode 100644 index 0000000..10fa123 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.sh @@ -0,0 +1,42 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: [] # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory unique multiple A suffix variable. + + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                            Description                                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynexample.var + string standard mandatory A variable inside dynamic family. + Default: val + diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.sh b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.sh new file mode 100644 index 0000000..68080f1 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.sh @@ -0,0 +1,54 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: a value # A dynamic variable with suffix {{ identifier }} +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/docs/no_namespace/60_0family_empty.sh b/tests/docs/no_namespace/60_0family_empty.sh new file mode 100644 index 0000000..9592dac --- /dev/null +++ b/tests/docs/no_namespace/60_0family_empty.sh @@ -0,0 +1,8 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +general2: + type: family +``` diff --git a/tests/docs/no_namespace/60_0family_hidden.sh b/tests/docs/no_namespace/60_0family_hidden.sh new file mode 100644 index 0000000..c589227 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_hidden.sh @@ -0,0 +1,19 @@ +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' +family: + redefine: true + hidden: true +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: a variable + mandatory: false +``` diff --git a/tests/docs/no_namespace/60_0family_mode.sh b/tests/docs/no_namespace/60_0family_mode.sh new file mode 100644 index 0000000..b266757 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_mode.sh @@ -0,0 +1,29 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +family: # a family + var: + description: A variable + mode: basic + default: non +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var + string basic mandatory A variable. + Default: non + diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.sh b/tests/docs/no_namespace/60_1family_dynamic_jinja.sh new file mode 100644 index 0000000..3f0bc52 --- /dev/null +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.sh @@ -0,0 +1,56 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + jinja: | + {% for val in _.var %} + {{ loop.index }} + {% endfor %} + description: index of suffix value + var: val # a dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: index of suffix value. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dyn1.var + dyn2.var + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.sh b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.sh new file mode 100644 index 0000000..aa89c73 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.sh @@ -0,0 +1,71 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + a family + +basic + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh new file mode 100644 index 0000000..435c989 --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh @@ -0,0 +1,77 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: identifier +var2: + description: a varible outside dynamic family + default: + jinja: | + {{ _.dynval1.family.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A identifier variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a family inside dynamic family + +standard + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the identifier. + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.sh b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.sh new file mode 100644 index 0000000..4e3628a --- /dev/null +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.sh @@ -0,0 +1,68 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: # a suffx variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + default: + jinja: | + {{ _.dynval1.var }} + description: the value of var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A suffx variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + newvar + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.sh b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.sh new file mode 100644 index 0000000..dcee02a --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.sh @@ -0,0 +1,55 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: Suffix has value + default: + type: identifier +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory Suffix has value. + Default: the value of the identifier. + diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.sh b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.sh new file mode 100644 index 0000000..bbc041e --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.sh @@ -0,0 +1,60 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # A identifier variable + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + default: + jinja: | + {{ identifier }} + params: + identifier: + type: identifier + description: from suffix +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A identifier variable. + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.sh b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.sh new file mode 100644 index 0000000..4289965 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.sh @@ -0,0 +1,67 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + default: + - val1 + - val2 +dyn{{ identifier }}: + dynamic: + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + variable: _.dynval1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + dynval1 or dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                                                 Description                                             + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A variable calculated. + Default: the value of the variable "dynval1.var". + diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.sh b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.sh new file mode 100644 index 0000000..b52614e --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - val2 + hidden: + jinja: | + {% if suffix == 'val2' %} + disabled + {% endif %} + params: + suffix: + type: identifier + description: if suffix == 'val2' + + var: + description: a variable + mandatory: false + family: # a family + var: + description: a new variable + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +standard hidden + +Hidden: if suffix == 'val2'. + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable               Description           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard A variable. + + + a family + +standard + + + + +  Variable                    Description                + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string standard A new variable. + diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.sh b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.sh new file mode 100644 index 0000000..81e2252 --- /dev/null +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.sh @@ -0,0 +1,69 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside dynamic family + default: + type: identifier +var2: + description: a variable + default: + variable: _.dyn_val1.var +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dyn_val1.var + dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the identifier. + + + + + +  Variable                                                  Description                                              + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A variable. + Default: the value of the variable "dyn_val1.var". + diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.sh b/tests/docs/no_namespace/60_6family_dynamic_leadership.sh new file mode 100644 index 0000000..7ee307e --- /dev/null +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.sh @@ -0,0 +1,77 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique multiple A suffix variable. + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                               Description                                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.leadership.leader + dynval2.leadership.leader + string basic mandatory unique multiple A leader. + dynval1.leadership.follower1 + dynval2.leadership.follower1 + string standard A follower1. + dynval1.leadership.follower2 + dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.sh b/tests/docs/no_namespace/60_9family_dynamic_calc_both.sh new file mode 100644 index 0000000..f6af6ca --- /dev/null +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.sh @@ -0,0 +1,48 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: val2 # a suffix variable +dyn{{ identifier }}: + description: a dynamic family + dynamic: + - val1 + - variable: _.var + vardyn: # a dynamic variable +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A suffix variable. + Default: val2 + + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • the value of the variable "var". + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.vardyn + dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.sh b/tests/docs/no_namespace/68_0family_leadership_mode.sh new file mode 100644 index 0000000..b7dd1f5 --- /dev/null +++ b/tests/docs/no_namespace/68_0family_leadership_mode.sh @@ -0,0 +1,43 @@ +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +leader: + description: A leadership + type: leadership + leader: + description: A leader + multi: true + mandatory: false + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mode: basic +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic unique multiple A leader. + leader.follower1 + string standard A follower1. + leader.follower2 + string basic mandatory A follower2. + diff --git a/tests/test_force_optional.py b/tests/test_force_optional.py index 2d875b2..cc470f0 100644 --- a/tests/test_force_optional.py +++ b/tests/test_force_optional.py @@ -8,10 +8,10 @@ def test_dictionaries(): rougailconfig = get_rougail_config(backward_compatibility=False) rougailconfig['step.output'] = 'doc' rougailconfig['force_optional'] = True - #FIXME - rougailconfig['tiramisu_cache'] = 'p.py' +# rougailconfig['tiramisu_cache'] = 'p.py' dirs = [str(test_dir / 'force_optional')] rougailconfig['main_dictionaries'] = dirs + rougailconfig['doc.output_format'] = 'asciidoc' inventory = RougailOutputDoc(rougailconfig=rougailconfig) doc = inventory.gen_doc() result_file = test_dir / 'force_optional.adoc' diff --git a/tests/test_load.py b/tests/test_load.py index a2c6e92..04c3c7b 100644 --- a/tests/test_load.py +++ b/tests/test_load.py @@ -22,7 +22,7 @@ for test in dico_dirs.iterdir(): test_ok = list(test_ok) test_ok.sort() -# test_ok = ['00_9default_calculation_multi_optional2'] +# test_ok = ['60_0family_dynamic_variable_suffix'] @fixture(scope="module", params=test_ok) @@ -96,7 +96,7 @@ def _test_dictionaries(test, output, namespace, examples=False): else: name = 'no_namespace' doc += inventory.gen_doc() - doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc', 'json': '.json'}.get(output)) + doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc', 'json': '.json', 'console': '.sh'}.get(output)) if not doc_file.is_file(): with doc_file.open('w') as docfh: docfh.write(doc) @@ -109,6 +109,10 @@ def test_dictionaries_json(test_dir): _test_dictionaries(test_dir, 'json', True) +def test_dictionaries_console(test_dir): + _test_dictionaries(test_dir, 'console', True) + + def test_dictionaries_github(test_dir): _test_dictionaries(test_dir, 'github', True) @@ -127,6 +131,12 @@ def test_dictionaries_json_no_namespace(test_dir): _test_dictionaries(test_dir, 'json', False) +def test_dictionaries_console_no_namespace(test_dir): + if (dico_dirs / test_dir / 'force_namespace').is_file(): + return + _test_dictionaries(test_dir, 'console', False) + + def test_dictionaries_github_no_namespace(test_dir): if (dico_dirs / test_dir / 'force_namespace').is_file(): return