Compare commits
4 commits
246ad6c7e0
...
e06c9b1829
| Author | SHA1 | Date | |
|---|---|---|---|
| e06c9b1829 | |||
| d4b16e918b | |||
| 1ecd7abbe7 | |||
| c0cae3fc6e |
259 changed files with 3831 additions and 423 deletions
11
CHANGELOG.md
11
CHANGELOG.md
|
|
@ -1,3 +1,14 @@
|
|||
## 0.2.0a46 (2026-01-29)
|
||||
|
||||
### Feat
|
||||
|
||||
- support transitive
|
||||
|
||||
### Fix
|
||||
|
||||
- better transitive documentation
|
||||
- update translation
|
||||
|
||||
## 0.2.0a45 (2026-01-21)
|
||||
|
||||
### Feat
|
||||
|
|
|
|||
|
|
@ -35,6 +35,10 @@ include_toc: true
|
|||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Ligne de commande** : <br/>--doc.other_root_filenames.root_path<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | Ce fichier contient les variables enfants de la famille. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Ligne de commande** : <br/>--doc.other_root_filenames.filename<br/>**Variable d'environnement** : DOC.OTHER_ROOT_FILENAMES.FILENAME | Nom du fichier. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | • le nom de fichier peut être une chemin relatif<br/>• type de fichier autorisé: "file". |
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.document_a_type" name="doc.document_a_type">doc.document_a_type</a>**<br/>**Ligne de commande** : <br/>• --doc.document_a_type<br/>• --doc.no-document_a_type<br/>**Variable d'environnement** : DOC.DOCUMENT_A_TYPE | Documenter type de structure. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||
|
||||
### Documentation des variables et journal de changements
|
||||
|
||||
> [!NOTE]
|
||||
|
|
|
|||
|
|
@ -35,6 +35,10 @@ include_toc: true
|
|||
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>**Command line**: <br/>--doc.other_root_filenames.root_path<br/>**Environment variable**: DOC.OTHER_ROOT_FILENAMES.ROOT_PATH | This file contains child variables of the family. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `unique` |
|
||||
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>**Command line**: <br/>--doc.other_root_filenames.filename<br/>**Environment variable**: DOC.OTHER_ROOT_FILENAMES.FILENAME | Name of the file. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | • this filename could be a relative path<br/>• file type allowed: "file". |
|
||||
|
||||
| Variable | Description | Default value | Type |
|
||||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
|
||||
| **<a id="doc.document_a_type" name="doc.document_a_type">doc.document_a_type</a>**<br/>**Command line**: <br/>• --doc.document_a_type<br/>• --doc.no-document_a_type<br/>**Environment variable**: DOC.DOCUMENT_A_TYPE | Documentation a structural type. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||
|
||||
### Variables and changelog documentation
|
||||
|
||||
> [!NOTE]
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: \n"
|
||||
"POT-Creation-Date: 2026-01-04 19:14+0100\n"
|
||||
"PO-Revision-Date: 2026-01-04 19:15+0100\n"
|
||||
"POT-Creation-Date: 2026-01-29 08:31+0100\n"
|
||||
"PO-Revision-Date: 2026-01-29 08:33+0100\n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"Language: fr\n"
|
||||
|
|
@ -16,19 +16,11 @@ msgstr ""
|
|||
"Generated-By: pygettext.py 1.5\n"
|
||||
"X-Generator: Poedit 3.8\n"
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:350
|
||||
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:353
|
||||
msgid "the value of the global information \"{0}\""
|
||||
msgstr "la valeur de l'information globale \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:360
|
||||
#: src/rougail/output_doc/annotator.py:371
|
||||
msgid "when the identifier is \"{0}\""
|
||||
msgstr "lorsque l'identifiant est \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:362
|
||||
#: src/rougail/output_doc/annotator.py:373
|
||||
msgid "when the identifier is not \"{0}\""
|
||||
msgstr "lorsque l'identifiant n'est pas \"{0}\""
|
||||
|
||||
|
|
@ -174,10 +166,14 @@ msgid "Name of the file"
|
|||
msgstr "Nom du fichier"
|
||||
|
||||
#: src/rougail/output_doc/config.py:206
|
||||
msgid "Documentation a structural type"
|
||||
msgstr "Documenter type de structure"
|
||||
|
||||
#: src/rougail/output_doc/config.py:210
|
||||
msgid "Variables and changelog documentation"
|
||||
msgstr "Documentation des variables et journal de changements"
|
||||
|
||||
#: src/rougail/output_doc/config.py:211
|
||||
#: src/rougail/output_doc/config.py:215
|
||||
msgid ""
|
||||
"if \"_.output_format\" is json or \"_.contents\" hasn't variables or "
|
||||
"changelog"
|
||||
|
|
@ -185,45 +181,45 @@ msgstr ""
|
|||
"si \"_.output_format\" en json ou si \"_.contents\" n'est pas variables ou "
|
||||
"changelog"
|
||||
|
||||
#: src/rougail/output_doc/config.py:214
|
||||
#: src/rougail/output_doc/config.py:218
|
||||
msgid "Do not add families in documentation"
|
||||
msgstr "Ne pas ajouter les familles dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
#: src/rougail/output_doc/config.py:223
|
||||
msgid "Add command line informations in documentation"
|
||||
msgstr "Ajoute les informations de la ligne de commande dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:224
|
||||
#: src/rougail/output_doc/config.py:228
|
||||
msgid "Add environment variable informations in documentation"
|
||||
msgstr ""
|
||||
"Ajoute les informations de variable d'environnement dans la documentation"
|
||||
|
||||
#: src/rougail/output_doc/config.py:229
|
||||
#: src/rougail/output_doc/config.py:233
|
||||
msgid "Environment variables prefix name"
|
||||
msgstr "Préfixe du nom des variables d'environnement"
|
||||
|
||||
#: src/rougail/output_doc/config.py:236
|
||||
#: src/rougail/output_doc/config.py:240
|
||||
msgid "should only use uppercase characters"
|
||||
msgstr "doit seulement utilise des caractères en majuscule"
|
||||
|
||||
#: src/rougail/output_doc/config.py:241
|
||||
#: src/rougail/output_doc/config.py:245
|
||||
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||
msgstr ""
|
||||
"si \"main_namespace\" n'est pas défini ou \"_.with_environment\" est false"
|
||||
|
||||
#: src/rougail/output_doc/config.py:244
|
||||
#: src/rougail/output_doc/config.py:248
|
||||
msgid "Changelog documentation"
|
||||
msgstr "Documentation du journal des changements"
|
||||
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
#: src/rougail/output_doc/config.py:253
|
||||
msgid "if changelog in not in \"_.contents\""
|
||||
msgstr "changelog n'est pas défini dans \"_.contents\""
|
||||
|
||||
#: src/rougail/output_doc/config.py:252
|
||||
#: src/rougail/output_doc/config.py:256
|
||||
msgid "Previous description file in JSON format"
|
||||
msgstr "Précédent fichier de description au format JSON"
|
||||
|
||||
#: src/rougail/output_doc/config.py:253
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
msgid ""
|
||||
"To generate the changelog, you need to compare the old list of variables (in "
|
||||
"json format) with the current variables."
|
||||
|
|
@ -231,162 +227,162 @@ msgstr ""
|
|||
"Pour générer le journal des changements, vous devez comparer l'ancienne "
|
||||
"liste des variables (au format json) avec les variables courantes."
|
||||
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
#: src/rougail/output_doc/config.py:261
|
||||
msgid "Examples configuration"
|
||||
msgstr "Configuration des exemples"
|
||||
|
||||
#: src/rougail/output_doc/config.py:262
|
||||
#: src/rougail/output_doc/config.py:266
|
||||
msgid "if example is not in \"_.contents\""
|
||||
msgstr "si example n'est pas défini dans \"_.contents\""
|
||||
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
#: src/rougail/output_doc/config.py:269
|
||||
msgid "Add description of variables and families when generate examples"
|
||||
msgstr ""
|
||||
"Ajouter la description des variables et des familles lorsqu'on génère des "
|
||||
"exemples"
|
||||
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
#: src/rougail/output_doc/config.py:274
|
||||
msgid "Comment in examples starts at column"
|
||||
msgstr "Commentaire dans les exemples commence à la colonne"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:354
|
||||
#: src/rougail/output_doc/doc.py:70
|
||||
msgid "{0} is not set as step.output"
|
||||
msgstr "{0} n'est pas défini dans step.output"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:363
|
||||
msgid "This family contains lists of variable blocks"
|
||||
msgstr "Cette famille contient des listes de bloc de variable"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:364
|
||||
#: src/rougail/output_doc/doc.py:373
|
||||
msgid "This family builds families dynamically"
|
||||
msgstr "Cette famille construit des familles dynamiquement"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:378
|
||||
#: src/rougail/output_doc/doc.py:387
|
||||
msgid "Default"
|
||||
msgstr "Défaut"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:396
|
||||
#: src/rougail/output_doc/doc.py:405
|
||||
msgid "Example"
|
||||
msgstr "Exemple"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:399
|
||||
#: src/rougail/output_doc/doc.py:408
|
||||
msgid "Examples"
|
||||
msgstr "Exemples"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:408
|
||||
#: src/rougail/output_doc/doc.py:417
|
||||
msgid "Tag"
|
||||
msgstr "Étiquette"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:411
|
||||
#: src/rougail/output_doc/doc.py:420
|
||||
msgid "Tags"
|
||||
msgstr "Étiquettes"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:443
|
||||
#: src/rougail/output_doc/doc.py:452
|
||||
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
||||
msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:578
|
||||
#: src/rougail/output_doc/doc.py:587
|
||||
msgid "text based with regular expressions \"{0}\""
|
||||
msgstr "texte avec expression rationnelle \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:582
|
||||
#: src/rougail/output_doc/doc.py:591
|
||||
#: src/rougail/output_doc/tabular/six_columns.py:65
|
||||
msgid "Validator"
|
||||
msgstr "Validateur"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:585
|
||||
#: src/rougail/output_doc/doc.py:594
|
||||
msgid "Validators"
|
||||
msgstr "Validateurs"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:594
|
||||
#: src/rougail/output_doc/doc.py:603
|
||||
msgid "Choices"
|
||||
msgstr "Choix"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:697
|
||||
#: src/rougail/output_doc/doc.py:707
|
||||
msgid "the value of the identifier"
|
||||
msgstr "la valeur de l'identifiant"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:701
|
||||
#: src/rougail/output_doc/doc.py:711
|
||||
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/doc.py:715
|
||||
msgid "the value of the global information \"{0}\""
|
||||
msgstr "la valeur de l'information globale \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:717
|
||||
msgid "the value of the {0}"
|
||||
msgstr "la valeur de l'{0}"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:710
|
||||
#: src/rougail/output_doc/doc.py:724
|
||||
msgid "depends on a calculation"
|
||||
msgstr "dépend d'un calcul"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:716
|
||||
#: src/rougail/output_doc/doc.py:730
|
||||
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:744
|
||||
msgid "the value of the variable \"{0}\""
|
||||
msgstr "la valeur de la variable \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:746
|
||||
msgid "the value of the variable \"{0}\" if it is defined"
|
||||
msgstr "la valeur de la variable \"{0}\" si elle est définie"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:766
|
||||
msgid "the value of an undocumented variable"
|
||||
msgstr "la valeur d'une variable non documentée"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:769
|
||||
msgid "the values of undocumented variables"
|
||||
msgstr "les valeurs de variables non documentées"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:792
|
||||
msgid "(from an undocumented variable)"
|
||||
msgstr "(issue d'une variable non documentée)"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:800
|
||||
msgid "{0} (from an undocumented variable)"
|
||||
msgstr "{0} (issue d'une variable non documentée)"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:804 src/rougail/output_doc/doc.py:856
|
||||
#: src/rougail/output_doc/doc.py:786 src/rougail/output_doc/doc.py:913
|
||||
msgid "depends on an undocumented variable"
|
||||
msgstr "dépends d'une variable non documentée"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:804
|
||||
msgid "is \"{0}\""
|
||||
msgstr "est \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:809
|
||||
msgid "is accessible"
|
||||
msgstr "est accessible"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:811
|
||||
msgid "is defined"
|
||||
msgstr "est définie"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:816
|
||||
msgid "hasn't the value \"{0}\""
|
||||
msgstr "n'a pas la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:820
|
||||
msgid "has the value \"{0}\""
|
||||
msgstr "a la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:825
|
||||
msgid "is {0}"
|
||||
msgstr "est {0}"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:826
|
||||
msgid "when the variable \"{{0}}\" {0}"
|
||||
msgstr "lorsque la variable \"{{0}}\" {0}"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:853
|
||||
msgid "the value of the variable \"{0}\" if it is defined"
|
||||
msgstr "la valeur de la variable \"{0}\" si elle est définie"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:855
|
||||
msgid "the value of the variable \"{0}\""
|
||||
msgstr "la valeur de la variable \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:875
|
||||
msgid "the value of an undocumented variable"
|
||||
msgstr "la valeur d'une variable non documentée"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:878
|
||||
msgid ""
|
||||
"when the variable \"{{0}}\" is defined, accessible and hasn't the value "
|
||||
"\"{0}\""
|
||||
msgstr ""
|
||||
"lorsque la variable \"{{0}}\" est définie, accessible et n'a pas la valeur "
|
||||
"\"{0}\""
|
||||
msgid "the values of undocumented variables"
|
||||
msgstr "les valeurs de variables non documentées"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:882
|
||||
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
||||
msgstr "lorsque la variable \"{{0}}\" est définie et n'a pas la valeur \"{0}\""
|
||||
#: src/rougail/output_doc/doc.py:901
|
||||
msgid "(from an undocumented variable)"
|
||||
msgstr "(issue d'une variable non documentée)"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:886
|
||||
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
||||
msgstr ""
|
||||
"lorsque la variable \"{{0}}\" est accessible et n'a pas la valeur \"{0}\""
|
||||
#: src/rougail/output_doc/doc.py:909
|
||||
msgid "{0} (from an undocumented variable)"
|
||||
msgstr "{0} (issue d'une variable non documentée)"
|
||||
|
||||
#: src/rougail/output_doc/doc.py:888
|
||||
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
||||
msgstr "lorsque la variable \"{{0}}\" n'a pas la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:892
|
||||
msgid ""
|
||||
"when the variable \"{{0}}\" is defined, is accessible and has the value "
|
||||
"\"{0}\""
|
||||
msgstr ""
|
||||
"lorsque la variable \"{{0}}\" est définie, accessible et a la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:896
|
||||
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
||||
msgstr "lorsque la variable \"{{0}}\" est définie et a la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:900
|
||||
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
||||
msgstr "lorsque la variable \"{{0}}\" est accessible et a la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:902
|
||||
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
||||
msgstr "lorsque la variable \"{{0}}\" a la valeur \"{0}\""
|
||||
|
||||
#: src/rougail/output_doc/example.py:62
|
||||
#: src/rougail/output_doc/example.py:70
|
||||
msgid "Example with mandatory variables not filled in"
|
||||
msgstr "Exemple avec des variables obligatoire non renseignée"
|
||||
|
||||
#: src/rougail/output_doc/example.py:69
|
||||
#: src/rougail/output_doc/example.py:85
|
||||
msgid "Example with all variables modifiable"
|
||||
msgstr "Exemple avec toutes les variables modifiable"
|
||||
|
||||
|
|
@ -424,24 +420,59 @@ msgstr "Ligne de commande"
|
|||
msgid "Environment variable"
|
||||
msgstr "Variable d'environnement"
|
||||
|
||||
#: src/rougail/output_doc/utils.py:437
|
||||
#: src/rougail/output_doc/utils.py:438
|
||||
msgid "Path"
|
||||
msgstr "Chemin"
|
||||
|
||||
#: src/rougail/output_doc/utils.py:447
|
||||
#: src/rougail/output_doc/utils.py:448
|
||||
msgid "Identifiers"
|
||||
msgstr "Identifiants"
|
||||
|
||||
#: src/rougail/output_doc/utils.py:663 src/rougail/output_doc/utils.py:672
|
||||
#: src/rougail/output_doc/utils.py:678 src/rougail/output_doc/utils.py:684
|
||||
#: src/rougail/output_doc/utils.py:688
|
||||
#: src/rougail/output_doc/utils.py:668 src/rougail/output_doc/utils.py:677
|
||||
#: src/rougail/output_doc/utils.py:683 src/rougail/output_doc/utils.py:689
|
||||
#: src/rougail/output_doc/utils.py:693
|
||||
msgid "(default)"
|
||||
msgstr "(défaut)"
|
||||
|
||||
#: src/rougail/output_doc/utils.py:940
|
||||
#: src/rougail/output_doc/utils.py:945
|
||||
msgid "{0}: {1}"
|
||||
msgstr "{0} : {1}"
|
||||
|
||||
#~ msgid ""
|
||||
#~ "when the variable \"{{0}}\" is defined, accessible and hasn't the value "
|
||||
#~ "\"{0}\""
|
||||
#~ msgstr ""
|
||||
#~ "lorsque la variable \"{{0}}\" est définie, accessible et n'a pas la "
|
||||
#~ "valeur \"{0}\""
|
||||
|
||||
#~ msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
||||
#~ msgstr ""
|
||||
#~ "lorsque la variable \"{{0}}\" est définie et n'a pas la valeur \"{0}\""
|
||||
|
||||
#~ msgid ""
|
||||
#~ "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
||||
#~ msgstr ""
|
||||
#~ "lorsque la variable \"{{0}}\" est accessible et n'a pas la valeur \"{0}\""
|
||||
|
||||
#~ msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
||||
#~ msgstr "lorsque la variable \"{{0}}\" n'a pas la valeur \"{0}\""
|
||||
|
||||
#~ msgid ""
|
||||
#~ "when the variable \"{{0}}\" is defined, is accessible and has the value "
|
||||
#~ "\"{0}\""
|
||||
#~ msgstr ""
|
||||
#~ "lorsque la variable \"{{0}}\" est définie, accessible et a la valeur "
|
||||
#~ "\"{0}\""
|
||||
|
||||
#~ msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
||||
#~ msgstr "lorsque la variable \"{{0}}\" est définie et a la valeur \"{0}\""
|
||||
|
||||
#~ msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
||||
#~ msgstr "lorsque la variable \"{{0}}\" est accessible et a la valeur \"{0}\""
|
||||
|
||||
#~ msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
||||
#~ msgstr "lorsque la variable \"{{0}}\" a la valeur \"{0}\""
|
||||
|
||||
#~ msgid "Document the child variables of the family"
|
||||
#~ msgstr "Documenter les variables enfants de cette famille"
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: PACKAGE VERSION\n"
|
||||
"POT-Creation-Date: 2026-01-04 19:15+0100\n"
|
||||
"POT-Creation-Date: 2026-01-29 08:33+0100\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
|
|
@ -15,19 +15,11 @@ msgstr ""
|
|||
"Generated-By: pygettext.py 1.5\n"
|
||||
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:350
|
||||
msgid "the value of the information \"{0}\" of the variable \"{1}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:353
|
||||
msgid "the value of the global information \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:360
|
||||
#: src/rougail/output_doc/annotator.py:371
|
||||
msgid "when the identifier is \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/annotator.py:362
|
||||
#: src/rougail/output_doc/annotator.py:373
|
||||
msgid "when the identifier is not \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
|
|
@ -140,199 +132,211 @@ msgid "Name of the file"
|
|||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:206
|
||||
msgid "Documentation a structural type"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:210
|
||||
msgid "Variables and changelog documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:211
|
||||
#: src/rougail/output_doc/config.py:215
|
||||
msgid "if \"_.output_format\" is json or \"_.contents\" hasn't variables or changelog"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:214
|
||||
#: src/rougail/output_doc/config.py:218
|
||||
msgid "Do not add families in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:219
|
||||
#: src/rougail/output_doc/config.py:223
|
||||
msgid "Add command line informations in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:224
|
||||
#: src/rougail/output_doc/config.py:228
|
||||
msgid "Add environment variable informations in documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:229
|
||||
#: src/rougail/output_doc/config.py:233
|
||||
msgid "Environment variables prefix name"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:236
|
||||
#: src/rougail/output_doc/config.py:240
|
||||
msgid "should only use uppercase characters"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:241
|
||||
#: src/rougail/output_doc/config.py:245
|
||||
msgid "if \"main_namespace\" is not set or \"_.with_environment\" is false"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:244
|
||||
#: src/rougail/output_doc/config.py:248
|
||||
msgid "Changelog documentation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:249
|
||||
#: src/rougail/output_doc/config.py:253
|
||||
msgid "if changelog in not in \"_.contents\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:252
|
||||
#: src/rougail/output_doc/config.py:256
|
||||
msgid "Previous description file in JSON format"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:253
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
msgid "To generate the changelog, you need to compare the old list of variables (in json format) with the current variables."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:257
|
||||
#: src/rougail/output_doc/config.py:261
|
||||
msgid "Examples configuration"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:262
|
||||
#: src/rougail/output_doc/config.py:266
|
||||
msgid "if example is not in \"_.contents\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:265
|
||||
#: src/rougail/output_doc/config.py:269
|
||||
msgid "Add description of variables and families when generate examples"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/config.py:270
|
||||
#: src/rougail/output_doc/config.py:274
|
||||
msgid "Comment in examples starts at column"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:354
|
||||
#: src/rougail/output_doc/doc.py:70
|
||||
msgid "{0} is not set as step.output"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:363
|
||||
msgid "This family contains lists of variable blocks"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:364
|
||||
#: src/rougail/output_doc/doc.py:373
|
||||
msgid "This family builds families dynamically"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:378
|
||||
#: src/rougail/output_doc/doc.py:387
|
||||
msgid "Default"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:396
|
||||
#: src/rougail/output_doc/doc.py:405
|
||||
msgid "Example"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:399
|
||||
#: src/rougail/output_doc/doc.py:408
|
||||
msgid "Examples"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:408
|
||||
#: src/rougail/output_doc/doc.py:417
|
||||
msgid "Tag"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:411
|
||||
#: src/rougail/output_doc/doc.py:420
|
||||
msgid "Tags"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:443
|
||||
#: src/rougail/output_doc/doc.py:452
|
||||
msgid "No attribute \"description\" for \"{0}\" in {1}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:578
|
||||
#: src/rougail/output_doc/doc.py:587
|
||||
msgid "text based with regular expressions \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:582
|
||||
#: src/rougail/output_doc/doc.py:591
|
||||
#: src/rougail/output_doc/tabular/six_columns.py:65
|
||||
msgid "Validator"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:585
|
||||
#: src/rougail/output_doc/doc.py:594
|
||||
msgid "Validators"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:594
|
||||
#: src/rougail/output_doc/doc.py:603
|
||||
msgid "Choices"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:697
|
||||
#: src/rougail/output_doc/doc.py:707
|
||||
msgid "the value of the identifier"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:701
|
||||
#: src/rougail/output_doc/doc.py:711
|
||||
msgid "the value of the information \"{0}\" of the variable \"{1}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:715
|
||||
msgid "the value of the global information \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:717
|
||||
msgid "the value of the {0}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:710
|
||||
#: src/rougail/output_doc/doc.py:724
|
||||
msgid "depends on a calculation"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:716
|
||||
#: src/rougail/output_doc/doc.py:730
|
||||
msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:744
|
||||
msgid "the value of the variable \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:746
|
||||
msgid "the value of the variable \"{0}\" if it is defined"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:766
|
||||
msgid "the value of an undocumented variable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:769
|
||||
msgid "the values of undocumented variables"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:792
|
||||
msgid "(from an undocumented variable)"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:800
|
||||
msgid "{0} (from an undocumented variable)"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:804 src/rougail/output_doc/doc.py:856
|
||||
#: src/rougail/output_doc/doc.py:786 src/rougail/output_doc/doc.py:913
|
||||
msgid "depends on an undocumented variable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:804
|
||||
msgid "is \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:809
|
||||
msgid "is accessible"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:811
|
||||
msgid "is defined"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:816
|
||||
msgid "hasn't the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:820
|
||||
msgid "has the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:825
|
||||
msgid "is {0}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:826
|
||||
msgid "when the variable \"{{0}}\" {0}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:853
|
||||
msgid "the value of the variable \"{0}\" if it is defined"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:855
|
||||
msgid "the value of the variable \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:875
|
||||
msgid "the value of an undocumented variable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:878
|
||||
msgid "when the variable \"{{0}}\" is defined, accessible and hasn't the value \"{0}\""
|
||||
msgid "the values of undocumented variables"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:882
|
||||
msgid "when the variable \"{{0}}\" is defined and hasn't the value \"{0}\""
|
||||
#: src/rougail/output_doc/doc.py:901
|
||||
msgid "(from an undocumented variable)"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:886
|
||||
msgid "when the variable \"{{0}}\" is accessible and hasn't the value \"{0}\""
|
||||
#: src/rougail/output_doc/doc.py:909
|
||||
msgid "{0} (from an undocumented variable)"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:888
|
||||
msgid "when the variable \"{{0}}\" hasn't the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:892
|
||||
msgid "when the variable \"{{0}}\" is defined, is accessible and has the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:896
|
||||
msgid "when the variable \"{{0}}\" is defined and has the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:900
|
||||
msgid "when the variable \"{{0}}\" is accessible and has the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/doc.py:902
|
||||
msgid "when the variable \"{{0}}\" has the value \"{0}\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/example.py:62
|
||||
#: src/rougail/output_doc/example.py:70
|
||||
msgid "Example with mandatory variables not filled in"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/example.py:69
|
||||
#: src/rougail/output_doc/example.py:85
|
||||
msgid "Example with all variables modifiable"
|
||||
msgstr ""
|
||||
|
||||
|
|
@ -370,21 +374,21 @@ msgstr ""
|
|||
msgid "Environment variable"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/utils.py:437
|
||||
#: src/rougail/output_doc/utils.py:438
|
||||
msgid "Path"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/utils.py:447
|
||||
#: src/rougail/output_doc/utils.py:448
|
||||
msgid "Identifiers"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/utils.py:663 src/rougail/output_doc/utils.py:672
|
||||
#: src/rougail/output_doc/utils.py:678 src/rougail/output_doc/utils.py:684
|
||||
#: src/rougail/output_doc/utils.py:688
|
||||
#: src/rougail/output_doc/utils.py:668 src/rougail/output_doc/utils.py:677
|
||||
#: src/rougail/output_doc/utils.py:683 src/rougail/output_doc/utils.py:689
|
||||
#: src/rougail/output_doc/utils.py:693
|
||||
msgid "(default)"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/output_doc/utils.py:940
|
||||
#: src/rougail/output_doc/utils.py:945
|
||||
msgid "{0}: {1}"
|
||||
msgstr ""
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
|
|||
|
||||
[project]
|
||||
name = "rougail.output_doc"
|
||||
version = "0.2.0a45"
|
||||
version = "0.2.0a46"
|
||||
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
|
||||
readme = "README.md"
|
||||
description = "Rougail output doc"
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
__version__ = "0.2.0a45"
|
||||
__version__ = "0.2.0a46"
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ class Annotator(Walk):
|
|||
for family in self.get_families():
|
||||
self.add_informations_from_properties(family)
|
||||
if family.type == "dynamic":
|
||||
self.force_default_value_in_suffix_variable(family)
|
||||
self.force_default_value_in_identifier_variable(family)
|
||||
self.calculation_to_information(
|
||||
family.path,
|
||||
"dynamic",
|
||||
|
|
@ -84,7 +84,7 @@ class Annotator(Walk):
|
|||
True,
|
||||
)
|
||||
|
||||
def force_default_value_in_suffix_variable(self, family) -> None:
|
||||
def force_default_value_in_identifier_variable(self, family) -> None:
|
||||
if not self.default_values:
|
||||
return
|
||||
if not isinstance(family.dynamic, list):
|
||||
|
|
@ -222,7 +222,7 @@ class Annotator(Walk):
|
|||
if "type" in data or "description" in data:
|
||||
one_is_calculation = True
|
||||
datas.append(data)
|
||||
if one_is_calculation:
|
||||
if one_is_calculation and datas:
|
||||
self.objectspace.informations.add(
|
||||
path,
|
||||
f"{prop}_calculation",
|
||||
|
|
@ -287,16 +287,9 @@ class Annotator(Walk):
|
|||
"propertyerror": values.propertyerror,
|
||||
}
|
||||
if isinstance(values, InformationCalculation):
|
||||
value, variable_path = self.calculation_to_information_information(
|
||||
values, version, path
|
||||
)
|
||||
ret = {
|
||||
"type": "information",
|
||||
"value": value,
|
||||
}
|
||||
if variable_path:
|
||||
ret["path"] = variable_path
|
||||
return ret
|
||||
return self.calculation_to_information_information(
|
||||
values, version, path
|
||||
)
|
||||
if isinstance(values, (IdentifierCalculation, IdentifierPropertyCalculation)):
|
||||
return {
|
||||
"type": "identifier",
|
||||
|
|
@ -327,38 +320,48 @@ class Annotator(Walk):
|
|||
values.namespace,
|
||||
values.xmlfiles,
|
||||
)[0]
|
||||
if isinstance(values, VariableCalculation) and values.optional and not variable:
|
||||
if not variable or (isinstance(values, VariableCalculation) and values.optional and not variable):
|
||||
return None
|
||||
if variable:
|
||||
variable_path = variable.path
|
||||
values_calculation = {"path": variable.path}
|
||||
if prop in PROPERTY_ATTRIBUTE:
|
||||
# get comparative value
|
||||
# values_calculation["transitive"] = values.propertyerror == "transitive"
|
||||
if values.when_not is not undefined:
|
||||
value = values.when_not
|
||||
condition = "when_not"
|
||||
values_calculation["type"] = "condition"
|
||||
values_calculation["value"] = values.when_not
|
||||
values_calculation["condition"] = "when_not"
|
||||
elif values.when is not undefined:
|
||||
value = values.when
|
||||
condition = "when"
|
||||
values_calculation["type"] = "condition"
|
||||
values_calculation["value"] = values.when
|
||||
values_calculation["condition"] = "when"
|
||||
elif values.propertyerror == "transitive":
|
||||
values_calculation["type"] = "transitive"
|
||||
else:
|
||||
value = True
|
||||
condition = "when"
|
||||
|
||||
# set message
|
||||
values_calculation = (variable_path, value, condition)
|
||||
values_calculation["type"] = "condition"
|
||||
values_calculation["value"] = True
|
||||
values_calculation["condition"] = "when"
|
||||
else:
|
||||
values_calculation = variable_path
|
||||
|
||||
values_calculation["type"] = "variable"
|
||||
return values_calculation
|
||||
|
||||
def calculation_to_information_information(
|
||||
self, values, version: str, path: str
|
||||
) -> Union[str, bool]:
|
||||
values_calculation = {"type": "information",
|
||||
"information": values.information,
|
||||
}
|
||||
if values.variable:
|
||||
variable_path = self.get_path_from_variable(values, version, path)
|
||||
return _('the value of the information "{0}" of the variable "{{0}}"').format(
|
||||
values.information
|
||||
), variable_path
|
||||
return _('the value of the global information "{0}"').format(values.information), None
|
||||
variable = self.objectspace.paths.get_with_dynamic(
|
||||
values.variable,
|
||||
path,
|
||||
values.version,
|
||||
values.namespace,
|
||||
values.xmlfiles,
|
||||
)[0]
|
||||
if not variable:
|
||||
return None
|
||||
values_calculation["path"] = variable.path
|
||||
return values_calculation
|
||||
|
||||
def calculation_to_information_identifier(
|
||||
self, values, prop: str, version: str
|
||||
|
|
|
|||
|
|
@ -226,9 +226,9 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
return True
|
||||
|
||||
calculation = child.information.get(f"{hidden_property}_calculation", None)
|
||||
if calculation and calculation.get("type") == "variable":
|
||||
variable_path, value, condition = calculation["value"]
|
||||
variable = self.true_config.forcepermissive.option(variable_path)
|
||||
if calculation and calculation.get("type") == "variable" and calculation["value"]["type"] == "condition":
|
||||
condition = calculation["value"]
|
||||
variable = self.true_config.forcepermissive.option(condition["path"])
|
||||
try:
|
||||
variable.value.get()
|
||||
except AttributeError:
|
||||
|
|
@ -239,7 +239,9 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
except VariableCalculationDependencyError:
|
||||
pass
|
||||
else:
|
||||
if (condition == "when" and value == variable_value) or (condition == "when_not" and value != variable_value):
|
||||
condition_type = condition["condition"]
|
||||
value = condition["value"]
|
||||
if (condition_type == "when" and value == variable_value) or (condition_type == "when_not" and value != variable_value):
|
||||
return True
|
||||
if not child.isoptiondescription():
|
||||
for hidden_property in self.disabled_modes:
|
||||
|
|
@ -685,7 +687,7 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
return values
|
||||
return self._calculation_to_string(child, calculation, prop)
|
||||
|
||||
def _calculation_to_string(self, child, calculation, prop):
|
||||
def _calculation_to_string(self, child, calculation, attribute_type):
|
||||
if "description" in calculation:
|
||||
values = calculation
|
||||
if self.document_a_type and "variables" in values:
|
||||
|
|
@ -695,24 +697,27 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
elif "type" not in calculation:
|
||||
values = calculation["value"]
|
||||
elif calculation["type"] == "jinja":
|
||||
values = self._calculation_jinja_to_string(child, calculation, prop)
|
||||
values = self._calculation_jinja_to_string(child, calculation, attribute_type)
|
||||
elif calculation["type"] == "variable":
|
||||
values = self._calculation_variable_to_string(child, calculation, prop)
|
||||
values = self._calculation_variable_to_string(child, calculation, attribute_type)
|
||||
elif calculation["type"] == "identifier":
|
||||
if prop in PROPERTY_ATTRIBUTE:
|
||||
if attribute_type in PROPERTY_ATTRIBUTE:
|
||||
values = calculation["value"]
|
||||
else:
|
||||
values = _("the value of the identifier")
|
||||
elif calculation["type"] == "information":
|
||||
values = calculation["value"]
|
||||
if "path" in calculation:
|
||||
variable_path = self.doc_path(calculation["path"])
|
||||
values = values.format(variable_path)
|
||||
values = _('the value of the information "{0}" of the variable "{1}"').format(
|
||||
calculation["information"], variable_path
|
||||
)
|
||||
else:
|
||||
values = _('the value of the global information "{0}"').format(calculation["information"])
|
||||
else:
|
||||
values = _("the value of the {0}").format(calculation["type"])
|
||||
return values
|
||||
|
||||
def _calculation_jinja_to_string(self, child, calculation, prop):
|
||||
def _calculation_jinja_to_string(self, child, calculation, attribute_type):
|
||||
if calculation["value"] is not True:
|
||||
values = calculation["value"]
|
||||
else:
|
||||
|
|
@ -725,7 +730,7 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
warning = _(
|
||||
'"{0}" is a calculation for {1} but has no description in {2}'
|
||||
).format(
|
||||
prop,
|
||||
attribute_type,
|
||||
self.doc_path(child.path()),
|
||||
display_xmlfiles(child.information.get("ymlfiles")),
|
||||
)
|
||||
|
|
@ -735,107 +740,16 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
)
|
||||
return values
|
||||
|
||||
def _calculation_variable_to_string(self, child, calculation, prop):
|
||||
if prop in PROPERTY_ATTRIBUTE:
|
||||
values = self._calculation_variable_to_string_known_property(child, calculation, prop)
|
||||
def _calculation_variable_to_string(self, child, calculation, attribute_type):
|
||||
if attribute_type in PROPERTY_ATTRIBUTE:
|
||||
func = self._calculation_variable_to_string_known_property
|
||||
else:
|
||||
if calculation["optional"]:
|
||||
path = calculation["value"]
|
||||
if "{{ identifier }}" in path:
|
||||
if path not in self.dynamic_paths:
|
||||
return None
|
||||
else:
|
||||
try:
|
||||
self.true_config.forcepermissive.option(path).get()
|
||||
except AttributeError:
|
||||
return None
|
||||
if not calculation["optional"]:
|
||||
true_msg = _('the value of the variable "{0}"')
|
||||
else:
|
||||
true_msg = _('the value of the variable "{0}" if it is defined')
|
||||
if "{{ identifier }}" in calculation["ori_path"]:
|
||||
values = []
|
||||
all_is_undocumented = False
|
||||
for cpath, description, identifiers in self.get_annotation_variable(calculation["value"], calculation["ori_path"]):
|
||||
if cpath:
|
||||
all_is_undocumented = False
|
||||
path_obj = {
|
||||
"path": self.doc_path(cpath),
|
||||
}
|
||||
if identifiers:
|
||||
path_obj["identifiers"] = identifiers
|
||||
values.append({
|
||||
"message": true_msg,
|
||||
"path": path_obj,
|
||||
"description": description,
|
||||
})
|
||||
else:
|
||||
if all_is_undocumented is None:
|
||||
all_is_undocumented = True
|
||||
values.append(_("the value of an undocumented variable"))
|
||||
if all_is_undocumented:
|
||||
if len(values) > 1:
|
||||
values = _("the values of undocumented variables")
|
||||
else:
|
||||
values = values[0]
|
||||
else:
|
||||
# FIXME A MUTUALISER AUSSI
|
||||
variable_path = calculation["ori_path"]
|
||||
variable = self.true_config.unrestraint.option(variable_path)
|
||||
try:
|
||||
isfollower = variable.isfollower()
|
||||
except AttributeError:
|
||||
pass
|
||||
else:
|
||||
if not isfollower and self.is_inaccessible_user_data(variable):
|
||||
try:
|
||||
uncalculated = variable.value.get(uncalculated=True)
|
||||
except PropertiesOptionError:
|
||||
true_msg = None
|
||||
else:
|
||||
if uncalculated and not isinstance(
|
||||
uncalculated, Calculation
|
||||
):
|
||||
if isinstance(uncalculated, list):
|
||||
true_msg = {
|
||||
"submessage": _(
|
||||
"(from an undocumented variable)"
|
||||
),
|
||||
"values": uncalculated,
|
||||
}
|
||||
else:
|
||||
if not isinstance(uncalculated, str):
|
||||
uncalculated = dump(uncalculated)
|
||||
true_msg = _(
|
||||
"{0} (from an undocumented variable)"
|
||||
).format(uncalculated)
|
||||
else:
|
||||
true_msg = _("depends on an undocumented variable")
|
||||
if true_msg:
|
||||
if isinstance(true_msg, dict):
|
||||
values = true_msg
|
||||
else:
|
||||
try:
|
||||
description = self._convert_description(self.true_config.option(calculation["ori_path"]).description(uncalculated=True), "description", its_a_path=False)
|
||||
except AttributeError:
|
||||
description = calculation["ori_path"]
|
||||
values = {
|
||||
"message": true_msg,
|
||||
"path": {
|
||||
"path": self.doc_path(calculation["ori_path"]),
|
||||
},
|
||||
"description": description,
|
||||
}
|
||||
else:
|
||||
values = None
|
||||
return values
|
||||
func = self._calculation_variable_to_string_not_properties
|
||||
return func(child, calculation, attribute_type)
|
||||
|
||||
def _calculation_variable_to_string_known_property(self, child, calculation, prop):
|
||||
variable_path, value, condition = calculation["value"]
|
||||
if isinstance(value, str):
|
||||
str_value = value
|
||||
else:
|
||||
str_value = dump(value)
|
||||
condition = calculation["value"]
|
||||
variable_path = condition["path"]
|
||||
values = []
|
||||
if "{{ identifier }}" in calculation["ori_path"] or "{{ identifier }}" in variable_path:
|
||||
variables = self.get_annotation_variable(variable_path, calculation["ori_path"])
|
||||
|
|
@ -853,83 +767,169 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
description = self._convert_description(option.description(uncalculated=True), "description", its_a_path=False)
|
||||
variables = [[variable_path, description, None]]
|
||||
for cpath, description, identifiers in variables:
|
||||
if calculation["propertyerror"] == "transitive":
|
||||
if not cpath:
|
||||
return True
|
||||
if not cpath:
|
||||
# we cannot access to this variable, so try with permissive
|
||||
if condition["type"] == "transitive":
|
||||
value = None
|
||||
else:
|
||||
print(variable_path)
|
||||
continue
|
||||
pass
|
||||
elif not cpath:
|
||||
# we cannot access to this variable so try with permissive
|
||||
variable = self.true_config.forcepermissive.option(variable_path)
|
||||
value = condition["value"]
|
||||
option = self.true_config.forcepermissive.option(variable_path)
|
||||
try:
|
||||
variable_value = self._get_unmodified_default_value(variable)
|
||||
variable_value = self._get_unmodified_default_value(option)
|
||||
except PropertiesOptionError as err:
|
||||
if calculation["propertyerror"] is True:
|
||||
raise err from err
|
||||
variable_value = value
|
||||
if calculation["propertyerror"] == "transitive":
|
||||
return True
|
||||
return False
|
||||
except VariableCalculationDependencyError:
|
||||
values.append(_("depends on an undocumented variable"))
|
||||
continue
|
||||
except AttributeError as err:
|
||||
return calculation.get("default", False)
|
||||
if (
|
||||
condition == "when"
|
||||
and value == variable_value
|
||||
or condition == "when_not"
|
||||
and value != variable_value
|
||||
):
|
||||
if prop in HIDDEN_PROPERTIES:
|
||||
return False
|
||||
# always "prop"
|
||||
if condition["type"] == "transitive":
|
||||
return True
|
||||
# never "prop"
|
||||
if prop in HIDDEN_PROPERTIES:
|
||||
condition_type = condition["condition"]
|
||||
if (
|
||||
condition_type == "when"
|
||||
and value == variable_value
|
||||
or condition_type == "when_not"
|
||||
and value != variable_value
|
||||
):
|
||||
# always "prop"
|
||||
return True
|
||||
return False
|
||||
if condition["type"] == "transitive":
|
||||
submsg = _('is "{0}"').format(prop)
|
||||
else:
|
||||
if condition == "when_not":
|
||||
if calculation["optional"]:
|
||||
if not calculation["propertyerror"]:
|
||||
msg = _(
|
||||
'when the variable "{{0}}" is defined, accessible and hasn\'t the value "{0}"'
|
||||
)
|
||||
else:
|
||||
msg = _(
|
||||
'when the variable "{{0}}" is defined and hasn\'t the value "{0}"'
|
||||
)
|
||||
elif not calculation["propertyerror"]:
|
||||
msg = _('when the variable "{{0}}" is accessible and hasn\'t the value "{0}"')
|
||||
else:
|
||||
msg = _('when the variable "{{0}}" hasn\'t the value "{0}"')
|
||||
condition_type = condition["condition"]
|
||||
conditions = []
|
||||
if not calculation["propertyerror"]:
|
||||
conditions.append(_("is accessible"))
|
||||
if calculation["optional"]:
|
||||
conditions.append(_("is defined"))
|
||||
value = condition["value"]
|
||||
if not isinstance(value, str):
|
||||
value = dump(value)
|
||||
if condition_type == "when_not":
|
||||
conditions.append(_(
|
||||
'hasn\'t the value "{0}"'
|
||||
).format(value))
|
||||
else:
|
||||
if calculation["optional"]:
|
||||
if not calculation["propertyerror"]:
|
||||
msg = _(
|
||||
'when the variable "{{0}}" is defined, is accessible and has the value "{0}"'
|
||||
)
|
||||
else:
|
||||
msg = _(
|
||||
'when the variable "{{0}}" is defined and has the value "{0}"'
|
||||
)
|
||||
elif not calculation["propertyerror"]:
|
||||
msg = _('when the variable "{{0}}" is accessible and has the value "{0}"')
|
||||
else:
|
||||
msg = _('when the variable "{{0}}" has the value "{0}"')
|
||||
path_obj = {
|
||||
"path": self.doc_path(variable_path),
|
||||
}
|
||||
if identifiers:
|
||||
path_obj["identifiers"] = identifiers
|
||||
conditions.append(_(
|
||||
'has the value "{0}"'
|
||||
).format(value))
|
||||
submsg = display_list(conditions, sort=False)
|
||||
if calculation["propertyerror"] == "transitive":
|
||||
submsg = display_list([_("is {0}").format(prop), submsg], separator="or", sort=False)
|
||||
msg = _('when the variable "{{0}}" {0}').format(submsg)
|
||||
path_obj = {
|
||||
"path": self.doc_path(variable_path),
|
||||
}
|
||||
if identifiers:
|
||||
path_obj["identifiers"] = identifiers
|
||||
|
||||
values.append({
|
||||
"message": msg.format(str_value),
|
||||
"path": path_obj,
|
||||
"description": description,
|
||||
})
|
||||
values.append({
|
||||
"message": msg,
|
||||
"path": path_obj,
|
||||
"description": description,
|
||||
})
|
||||
if len(values) == 1:
|
||||
return values[0]
|
||||
return values
|
||||
|
||||
def _calculation_variable_to_string_not_properties(self, child, calculation, attribute_type):
|
||||
if calculation["optional"]:
|
||||
path = calculation["value"]["path"]
|
||||
if "{{ identifier }}" in path:
|
||||
if path not in self.dynamic_paths:
|
||||
return None
|
||||
else:
|
||||
try:
|
||||
self.true_config.forcepermissive.option(path).get()
|
||||
except AttributeError:
|
||||
return None
|
||||
true_msg = _('the value of the variable "{0}" if it is defined')
|
||||
else:
|
||||
true_msg = _('the value of the variable "{0}"')
|
||||
if "{{ identifier }}" in calculation["ori_path"]:
|
||||
values = []
|
||||
all_is_undocumented = False
|
||||
for cpath, description, identifiers in self.get_annotation_variable(calculation["value"]["path"], calculation["ori_path"]):
|
||||
if cpath:
|
||||
all_is_undocumented = False
|
||||
path_obj = {
|
||||
"path": self.doc_path(cpath),
|
||||
}
|
||||
if identifiers:
|
||||
path_obj["identifiers"] = identifiers
|
||||
values.append({
|
||||
"message": true_msg,
|
||||
"path": path_obj,
|
||||
"description": description,
|
||||
})
|
||||
else:
|
||||
if all_is_undocumented is None:
|
||||
all_is_undocumented = True
|
||||
values.append(_("the value of an undocumented variable"))
|
||||
if all_is_undocumented:
|
||||
if len(values) > 1:
|
||||
values = _("the values of undocumented variables")
|
||||
else:
|
||||
values = values[0]
|
||||
else:
|
||||
# FIXME A MUTUALISER AUSSI
|
||||
variable_path = calculation["ori_path"]
|
||||
variable = self.true_config.unrestraint.option(variable_path)
|
||||
try:
|
||||
isfollower = variable.isfollower()
|
||||
except AttributeError:
|
||||
pass
|
||||
else:
|
||||
if not isfollower and self.is_inaccessible_user_data(variable):
|
||||
try:
|
||||
uncalculated = variable.value.get(uncalculated=True)
|
||||
except PropertiesOptionError:
|
||||
true_msg = None
|
||||
else:
|
||||
if uncalculated and not isinstance(
|
||||
uncalculated, Calculation
|
||||
):
|
||||
if isinstance(uncalculated, list):
|
||||
true_msg = {
|
||||
"submessage": _(
|
||||
"(from an undocumented variable)"
|
||||
),
|
||||
"values": uncalculated,
|
||||
}
|
||||
else:
|
||||
if not isinstance(uncalculated, str):
|
||||
uncalculated = dump(uncalculated)
|
||||
true_msg = _(
|
||||
"{0} (from an undocumented variable)"
|
||||
).format(uncalculated)
|
||||
else:
|
||||
true_msg = _("depends on an undocumented variable")
|
||||
if true_msg:
|
||||
if isinstance(true_msg, dict):
|
||||
values = true_msg
|
||||
else:
|
||||
try:
|
||||
description = self._convert_description(self.true_config.option(calculation["ori_path"]).description(uncalculated=True), "description", its_a_path=False)
|
||||
except AttributeError:
|
||||
description = calculation["ori_path"]
|
||||
values = {
|
||||
"message": true_msg,
|
||||
"path": {
|
||||
"path": self.doc_path(calculation["ori_path"]),
|
||||
},
|
||||
"description": description,
|
||||
}
|
||||
else:
|
||||
values = None
|
||||
return values
|
||||
|
||||
def get_annotation_variable(self, current_path, ori_path):
|
||||
if current_path == ori_path:
|
||||
regexp = None
|
||||
|
|
@ -959,7 +959,7 @@ class RougailOutputDoc(Examples, Changelog):
|
|||
if not calculation:
|
||||
return child.value.get()
|
||||
if calculation["type"] == "variable":
|
||||
variable = self.true_config.forcepermissive.option(calculation["value"])
|
||||
variable = self.true_config.forcepermissive.option(calculation["value"]["path"])
|
||||
if variable and self.is_inaccessible_user_data(variable):
|
||||
return self._get_unmodified_default_value(variable)
|
||||
raise VariableCalculationDependencyError()
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -2,8 +2,7 @@
|
|||
|====
|
||||
| Variable | Description
|
||||
| **var1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var1. +
|
||||
**Default**: the value of the variable "a.unknown.variable"
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var1.
|
||||
| **var2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var2. +
|
||||
**Default**: var calculated
|
||||
|
|
@ -13,17 +12,17 @@
|
|||
| **var4** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var4.
|
||||
| **var5** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var5. +
|
||||
**Default**: the value of the information "info" of the variable "a.unknown.variable"
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `mandatory` | My var5.
|
||||
| **var6** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var6. +
|
||||
**Choices**: the value of the variable "a.unknown.variable"
|
||||
**Choices**:
|
||||
|
||||
*
|
||||
| **var7** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var7. +
|
||||
**Choices**:
|
||||
|
||||
* the value of the variable "a.unknown.variable1"
|
||||
* the value of the variable "a.unknown.variable2"
|
||||
*
|
||||
| **var8** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var8. +
|
||||
**Choices**: the a.unknown.variable values
|
||||
|
|
@ -36,7 +35,7 @@
|
|||
|
||||
This family builds families dynamically. +
|
||||
**Path**: var___example__ +
|
||||
**Identifiers**: the value of the variable "a.unknown.variable"
|
||||
**Identifiers**: example
|
||||
====
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
|
|
|
|||
|
|
@ -0,0 +1,14 @@
|
|||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **condition** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. +
|
||||
**Default**: true
|
||||
| **variable1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A variable. +
|
||||
**Disabled**: when the variable "condition" has the value "true"
|
||||
| **variable2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A second variable. +
|
||||
**Disabled**: when the variable "variable1" is "disabled"
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<table>
|
||||
<thead>
|
||||
<tr><th>Variable </th><th>Description </th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><b>condition</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A condition.<br/><b>Default</b>: true </td></tr>
|
||||
<tr><td><b>variable1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A variable.<br/><b>Disabled</b>: when the variable "condition" has the value "true"</td></tr>
|
||||
<tr><td><b>variable2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A second variable.<br/><b>Disabled</b>: when the variable "variable1" is "disabled"</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
{
|
||||
"condition": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": true
|
||||
},
|
||||
"variable_type": "boolean",
|
||||
"path": "condition",
|
||||
"names": [
|
||||
"condition"
|
||||
],
|
||||
"description": "A condition.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
true
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable1": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "variable1",
|
||||
"names": [
|
||||
"variable1"
|
||||
],
|
||||
"description": "A variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" has the value \"true\"",
|
||||
"path": {
|
||||
"path": "condition"
|
||||
},
|
||||
"description": "A condition"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
},
|
||||
"variable2": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "variable2",
|
||||
"names": [
|
||||
"variable2"
|
||||
],
|
||||
"description": "A second variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" is \"disabled\"",
|
||||
"path": {
|
||||
"path": "variable1"
|
||||
},
|
||||
"description": "A variable"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mcondition[0m │ A condition. │
|
||||
│ [1;7m boolean [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: true │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable1[0m │ A variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "condition" has the value "true" │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "variable1" is "disabled" │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **condition** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. +
|
||||
**Default**: false
|
||||
| **variable1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `__disabled__` | A variable. +
|
||||
**Default**: disabled +
|
||||
**Disabled**: when the variable "condition" has the value "true"
|
||||
| **variable2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A second variable. +
|
||||
**Disabled**: when the variable "variable1" is disabled or has the value "disabled"
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: false |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable.<br/>**Default**: disabled<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is disabled or has the value "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<table>
|
||||
<thead>
|
||||
<tr><th>Variable </th><th>Description </th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><b>condition</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A condition.<br/><b>Default</b>: false </td></tr>
|
||||
<tr><td><b>variable1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A variable.<br/><b>Default</b>: disabled<br/><b>Disabled</b>: when the variable "condition" has the value "true"</td></tr>
|
||||
<tr><td><b>variable2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark> </td><td>A second variable.<br/><b>Disabled</b>: when the variable "variable1" is disabled or has the value "disabled" </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
{
|
||||
"condition": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": false
|
||||
},
|
||||
"variable_type": "boolean",
|
||||
"path": "condition",
|
||||
"names": [
|
||||
"condition"
|
||||
],
|
||||
"description": "A condition.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
false
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable1": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": "disabled"
|
||||
},
|
||||
"variable_type": "string",
|
||||
"path": "variable1",
|
||||
"names": [
|
||||
"variable1"
|
||||
],
|
||||
"description": "A variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" has the value \"true\"",
|
||||
"path": {
|
||||
"path": "condition"
|
||||
},
|
||||
"description": "A condition"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
"disabled"
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable2": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "variable2",
|
||||
"names": [
|
||||
"variable2"
|
||||
],
|
||||
"description": "A second variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" is disabled or has the value \"disabled\"",
|
||||
"path": {
|
||||
"path": "variable1"
|
||||
},
|
||||
"description": "A variable"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: false |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable.<br/>**Default**: disabled<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is disabled or has the value "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mcondition[0m │ A condition. │
|
||||
│ [1;7m boolean [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: false │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable1[0m │ A variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: disabled │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ │ "condition" has the value "true" │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "variable1" is disabled or has the │
|
||||
│ │ value "disabled" │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **condition** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. +
|
||||
**Default**: true
|
||||
| **variable1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `__disabled__` | A variable. +
|
||||
**Default**: not_disabled +
|
||||
**Disabled**: when the variable "condition" has the value "true"
|
||||
| **variable2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A second variable. +
|
||||
**Disabled**: when the variable "variable1" is disabled or has the value "disabled"
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable.<br/>**Default**: not_disabled<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is disabled or has the value "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<table>
|
||||
<thead>
|
||||
<tr><th>Variable </th><th>Description </th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><b>condition</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A condition.<br/><b>Default</b>: true </td></tr>
|
||||
<tr><td><b>variable1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>standard</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A variable.<br/><b>Default</b>: not_disabled<br/><b>Disabled</b>: when the variable "condition" has the value "true"</td></tr>
|
||||
<tr><td><b>variable2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark> </td><td>A second variable.<br/><b>Disabled</b>: when the variable "variable1" is disabled or has the value "disabled" </td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
{
|
||||
"condition": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": true
|
||||
},
|
||||
"variable_type": "boolean",
|
||||
"path": "condition",
|
||||
"names": [
|
||||
"condition"
|
||||
],
|
||||
"description": "A condition.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
true
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable1": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": "not_disabled"
|
||||
},
|
||||
"variable_type": "string",
|
||||
"path": "variable1",
|
||||
"names": [
|
||||
"variable1"
|
||||
],
|
||||
"description": "A variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" has the value \"true\"",
|
||||
"path": {
|
||||
"path": "condition"
|
||||
},
|
||||
"description": "A condition"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
"not_disabled"
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable2": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "variable2",
|
||||
"names": [
|
||||
"variable2"
|
||||
],
|
||||
"description": "A second variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" is disabled or has the value \"disabled\"",
|
||||
"path": {
|
||||
"path": "variable1"
|
||||
},
|
||||
"description": "A variable"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="condition" name="condition">condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="variable1" name="variable1">variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable.<br/>**Default**: not_disabled<br/>**Disabled**: when the variable "[A condition](#condition)" has the value "true" |
|
||||
| **<a id="variable2" name="variable2">variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#variable1)" is disabled or has the value "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mcondition[0m │ A condition. │
|
||||
│ [1;7m boolean [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: true │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable1[0m │ A variable. │
|
||||
│ [1;7m string [0m [1;7m standard [0m [1;7m mandatory [0m [1;7m [0m │ [1mDefault[0m: not_disabled │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ │ "condition" has the value "true" │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mvariable2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "variable1" is disabled or has the │
|
||||
│ │ value "disabled" │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable1: example
|
||||
variable2: example
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: true
|
||||
variable1: example
|
||||
variable2: example
|
||||
----
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable1: example
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true
|
||||
variable1: example
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable1: example
|
||||
variable2: example</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: true
|
||||
variable1: example
|
||||
variable2: example</pre>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable1: example
|
||||
variable2: example
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true
|
||||
variable1: example
|
||||
variable2: example
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable2: example
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: false
|
||||
variable1: disabled
|
||||
variable2: example
|
||||
----
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: false
|
||||
variable1: disabled
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable2: example</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: false
|
||||
variable1: disabled
|
||||
variable2: example</pre>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: false
|
||||
variable1: disabled
|
||||
variable2: example
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mfalse [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mdisabled [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable2: example
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: true
|
||||
variable1: not_disabled
|
||||
variable2: example
|
||||
----
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true
|
||||
variable1: not_disabled
|
||||
variable2: example
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable2: example</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: true
|
||||
variable1: not_disabled
|
||||
variable2: example</pre>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true
|
||||
variable1: not_disabled
|
||||
variable2: example
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mnot_disabled [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample [0m
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
----
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable1: example # A variable
|
||||
variable2: example # A second variable</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: true # A condition
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable</pre>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: example # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A variable[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A condition[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A variable[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable2: example # A second variable
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: false # A condition
|
||||
variable1: disabled # A variable
|
||||
variable2: example # A second variable
|
||||
----
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: false # A condition
|
||||
variable1: disabled # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable2: example # A second variable</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: false # A condition
|
||||
variable1: disabled # A variable
|
||||
variable2: example # A second variable</pre>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example # A second variable
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: false # A condition
|
||||
variable1: disabled # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mfalse[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A condition[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mdisabled[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A variable[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
== Example with mandatory variables not filled in
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
variable2: example # A second variable
|
||||
----
|
||||
== Example with all variables modifiable
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: not_disabled # A variable
|
||||
variable2: example # A second variable
|
||||
----
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<details><summary>Example with mandatory variables not filled in</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
<details><summary>Example with all variables modifiable</summary>
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: not_disabled # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<h1>Example with mandatory variables not filled in</h1>
|
||||
|
||||
<pre>variable2: example # A second variable</pre><h1>Example with all variables modifiable</h1>
|
||||
|
||||
<pre>condition: true # A condition
|
||||
variable1: not_disabled # A variable
|
||||
variable2: example # A second variable</pre>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Example with mandatory variables not filled in
|
||||
|
||||
```yaml
|
||||
---
|
||||
variable2: example # A second variable
|
||||
```
|
||||
# Example with all variables modifiable
|
||||
|
||||
```yaml
|
||||
---
|
||||
condition: true # A condition
|
||||
variable1: not_disabled # A variable
|
||||
variable2: example # A second variable
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
[1;4;96mExample with mandatory variables not filled in[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
[1;4;96mExample with all variables modifiable[0m
|
||||
|
||||
[38;2;248;248;242;48;2;39;40;34m---[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mcondition[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mtrue[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A condition[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable1[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mnot_disabled[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A variable[0m[48;2;39;40;34m [0m
|
||||
[38;2;255;70;137;48;2;39;40;34mvariable2[0m[38;2;248;248;242;48;2;39;40;34m:[0m[38;2;248;248;242;48;2;39;40;34m [0m[48;2;39;40;34mexample[0m[38;2;248;248;242;48;2;39;40;34m [0m[38;2;149;144;119;48;2;39;40;34m# A second variable[0m[48;2;39;40;34m [0m
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
[]
|
||||
|
|
@ -0,0 +1 @@
|
|||
[]
|
||||
|
|
@ -0,0 +1 @@
|
|||
[]
|
||||
|
|
@ -0,0 +1 @@
|
|||
[]
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
== Rougail
|
||||
|
||||
====
|
||||
**🛈 Informations**
|
||||
|
||||
**Path**: rougail +
|
||||
`basic`
|
||||
====
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **rougail.condition** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. +
|
||||
**Default**: true
|
||||
| **rougail.variable1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A variable. +
|
||||
**Disabled**: when the variable "rougail.condition" has the value "true"
|
||||
| **rougail.variable2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A second variable. +
|
||||
**Disabled**: when the variable "rougail.variable1" is "disabled"
|
||||
|====
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<details><summary>Rougail</summary>
|
||||
|
||||
> [!note] 🛈 Informations
|
||||
> **Path**: rougail\
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="rougail.condition" name="rougail.condition">rougail.condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="rougail.variable1" name="rougail.variable1">rougail.variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.<br/>**Disabled**: when the variable "[A condition](#rougail.condition)" has the value "true" |
|
||||
| **<a id="rougail.variable2" name="rougail.variable2">rougail.variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#rougail.variable1)" is "disabled" |
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
<h1>Rougail</h1>
|
||||
|
||||
<b>Path</b>: rougail
|
||||
|
||||
<mark>basic</mark>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Variable </th><th>Description </th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><b>rougail.condition</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>boolean</a></mark> <mark>standard</mark> <mark>mandatory</mark> </td><td>A condition.<br/><b>Default</b>: true </td></tr>
|
||||
<tr><td><b>rougail.variable1</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A variable.<br/><b>Disabled</b>: when the variable "rougail.condition" has the value "true"</td></tr>
|
||||
<tr><td><b>rougail.variable2</b><br/><mark><a href='https://rougail.readthedocs.io/en/latest/variable.html#variables-types'>string</a></mark> <mark>basic</mark> <mark>mandatory</mark> <mark><i>disabled</i></mark></td><td>A second variable.<br/><b>Disabled</b>: when the variable "rougail.variable1" is "disabled"</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
{
|
||||
"rougail": {
|
||||
"type": "namespace",
|
||||
"informations": {
|
||||
"path": "rougail",
|
||||
"names": [
|
||||
"rougail"
|
||||
],
|
||||
"description": "Rougail",
|
||||
"properties": [],
|
||||
"mode": "basic"
|
||||
},
|
||||
"children": {
|
||||
"condition": {
|
||||
"type": "variable",
|
||||
"default": {
|
||||
"name": "Default",
|
||||
"values": true
|
||||
},
|
||||
"variable_type": "boolean",
|
||||
"path": "rougail.condition",
|
||||
"names": [
|
||||
"condition"
|
||||
],
|
||||
"description": "A condition.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
}
|
||||
],
|
||||
"mode": "standard",
|
||||
"gen_examples": [
|
||||
true
|
||||
],
|
||||
"mandatory_without_value": false
|
||||
},
|
||||
"variable1": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "rougail.variable1",
|
||||
"names": [
|
||||
"variable1"
|
||||
],
|
||||
"description": "A variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" has the value \"true\"",
|
||||
"path": {
|
||||
"path": "rougail.condition"
|
||||
},
|
||||
"description": "A condition"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
},
|
||||
"variable2": {
|
||||
"type": "variable",
|
||||
"variable_type": "string",
|
||||
"path": "rougail.variable2",
|
||||
"names": [
|
||||
"variable2"
|
||||
],
|
||||
"description": "A second variable.",
|
||||
"properties": [
|
||||
{
|
||||
"type": "property",
|
||||
"name": "mandatory",
|
||||
"ori_name": "mandatory",
|
||||
"access_control": false
|
||||
},
|
||||
{
|
||||
"type": "property",
|
||||
"name": "disabled",
|
||||
"ori_name": "disabled",
|
||||
"access_control": true,
|
||||
"annotation": {
|
||||
"message": "when the variable \"{0}\" is \"disabled\"",
|
||||
"path": {
|
||||
"path": "rougail.variable1"
|
||||
},
|
||||
"description": "A variable"
|
||||
}
|
||||
}
|
||||
],
|
||||
"mode": "basic",
|
||||
"gen_examples": [
|
||||
"example"
|
||||
],
|
||||
"mandatory_without_value": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Rougail
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Path**: rougail\
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="rougail.condition" name="rougail.condition">rougail.condition</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.<br/>**Default**: true |
|
||||
| **<a id="rougail.variable1" name="rougail.variable1">rougail.variable1</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.<br/>**Disabled**: when the variable "[A condition](#rougail.condition)" has the value "true" |
|
||||
| **<a id="rougail.variable2" name="rougail.variable2">rougail.variable2</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.<br/>**Disabled**: when the variable "[A variable](#rougail.variable1)" is "disabled" |
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
[1;4;96mRougail[0m
|
||||
|
||||
[34m▌ [0m[1;34m🛈 Informations[0m
|
||||
[34m▌ [0m
|
||||
[34m▌ [0m[1mPath[0m: rougail
|
||||
[34m▌ [0m[1;7m basic [0m
|
||||
|
||||
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃[1m [0m[1mVariable [0m[1m [0m┃[1m [0m[1mDescription [0m[1m [0m┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ [1mrougail.condition[0m │ A condition. │
|
||||
│ [1;7m boolean [0m [1;7m standard [0m [1;7m mandatory [0m │ [1mDefault[0m: true │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.variable1[0m │ A variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "rougail.condition" has the value │
|
||||
│ │ "true" │
|
||||
├───────────────────────────────────────┼──────────────────────────────────────┤
|
||||
│ [1mrougail.variable2[0m │ A second variable. │
|
||||
│ [1;7m string [0m [1;7m basic [0m [1;7m mandatory [0m [1;7m [0m │ [1mDisabled[0m: when the variable │
|
||||
│ [1;3;7mdisabled[0m[1;7m [0m │ "rougail.variable1" is "disabled" │
|
||||
└───────────────────────────────────────┴──────────────────────────────────────┘
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
== Rougail
|
||||
|
||||
====
|
||||
**🛈 Informations**
|
||||
|
||||
**Path**: rougail +
|
||||
`basic`
|
||||
====
|
||||
[cols="1a,1a"]
|
||||
|====
|
||||
| Variable | Description
|
||||
| **rougail.condition** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | A condition. +
|
||||
**Default**: false
|
||||
| **rougail.variable1** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `__disabled__` | A variable. +
|
||||
**Default**: disabled +
|
||||
**Disabled**: when the variable "rougail.condition" has the value "true"
|
||||
| **rougail.variable2** +
|
||||
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | A second variable. +
|
||||
**Disabled**: when the variable "rougail.variable1" is disabled or has the value "disabled"
|
||||
|====
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue