diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py index 9b4afb4..c1b2d22 100644 --- a/src/rougail/output_doc/annotator.py +++ b/src/rougail/output_doc/annotator.py @@ -59,6 +59,8 @@ class Annotator(Walk): values = self.objectspace.informations.get(variable.path).get("examples", None) if not values: values = self.objectspace.informations.get(variable.path).get("test", None) + if isinstance(values, tuple): + values = list(values) return values def add_default_value( diff --git a/tests/docs/base/00_0version_underscore.adoc b/tests/docs/base/00_0version_underscore.adoc index b04ef5c..3b2076e 100644 --- a/tests/docs/base/00_0version_underscore.adoc +++ b/tests/docs/base/00_0version_underscore.adoc @@ -5,29 +5,15 @@ _version: '1.1' version: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.version** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - version: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - version: example ----- diff --git a/tests/docs/base/00_0version_underscore.md b/tests/docs/base/00_0version_underscore.md index 0477bbd..b2319bf 100644 --- a/tests/docs/base/00_0version_underscore.md +++ b/tests/docs/base/00_0version_underscore.md @@ -9,24 +9,10 @@ include_toc: true _version: '1.1' version: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - version: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - version: example -``` diff --git a/tests/docs/base/00_1empty_variable.adoc b/tests/docs/base/00_1empty_variable.adoc index f2eb080..659efe3 100644 --- a/tests/docs/base/00_1empty_variable.adoc +++ b/tests/docs/base/00_1empty_variable.adoc @@ -5,29 +5,15 @@ version: '1.0' empty: ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.empty** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Empty. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Empty. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - empty: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - empty: example ----- diff --git a/tests/docs/base/00_1empty_variable.md b/tests/docs/base/00_1empty_variable.md index 697252d..26e91b5 100644 --- a/tests/docs/base/00_1empty_variable.md +++ b/tests/docs/base/00_1empty_variable.md @@ -9,24 +9,10 @@ include_toc: true version: '1.0' empty: ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Empty. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - empty: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - empty: example -``` diff --git a/tests/docs/base/00_2default_calculated.adoc b/tests/docs/base/00_2default_calculated.adoc index 0146aa8..6f67e62 100644 --- a/tests/docs/base/00_2default_calculated.adoc +++ b/tests/docs/base/00_2default_calculated.adoc @@ -8,35 +8,25 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {{ _.var1 }} description: the value of var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: the value of var1. +**Défaut**: the value of var1. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: - - no ----- diff --git a/tests/docs/base/00_2default_calculated.md b/tests/docs/base/00_2default_calculated.md index ac86727..2f275df 100644 --- a/tests/docs/base/00_2default_calculated.md +++ b/tests/docs/base/00_2default_calculated.md @@ -12,25 +12,15 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {{ _.var1 }} description: the value of var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of var1. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**: the value of var1. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: - - no -``` diff --git a/tests/docs/base/00_2default_calculated_multi.adoc b/tests/docs/base/00_2default_calculated_multi.adoc index 7541750..d97fdd7 100644 --- a/tests/docs/base/00_2default_calculated_multi.adoc +++ b/tests/docs/base/00_2default_calculated_multi.adoc @@ -11,46 +11,31 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {% for val in _.var1 %} {{ val }} {% endfor %} description: the value of _.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: * no * yes -* maybe +* maybe | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: the value of _.var1. +**Défaut**: the value of _.var1. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - no - - yes - - maybe - var2: - - no - - yes - - maybe ----- diff --git a/tests/docs/base/00_2default_calculated_multi.md b/tests/docs/base/00_2default_calculated_multi.md index d398031..e90262d 100644 --- a/tests/docs/base/00_2default_calculated_multi.md +++ b/tests/docs/base/00_2default_calculated_multi.md @@ -15,32 +15,17 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {% for val in _.var1 %} {{ val }} {% endfor %} description: the value of _.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- no
- yes
- maybe | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of _.var1. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- no
- yes
- maybe | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**: the value of _.var1. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - no - - yes - - maybe - var2: - - no - - yes - - maybe -``` diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.adoc b/tests/docs/base/00_2default_calculated_variable_transitive.adoc new file mode 100644 index 0000000..022bbd0 --- /dev/null +++ b/tests/docs/base/00_2default_calculated_variable_transitive.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +---- +== Variables pour "rougail" + +[cols="134a,134a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `obligatoire` `unique` `multiple` | +A first variable. + +**Validator**: le nom de domaine peut être une IP +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: le nom de domaine peut être une IP + +**Défaut**: la valeur de la variable "rougail.var1". +|==== + + diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.md b/tests/docs/base/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..bc3646f --- /dev/null +++ b/tests/docs/base/00_2default_calculated_variable_transitive.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +``` +# Variables pour "rougail" + +| Variable                                                                                                                             | Description                                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first variable.
**Validator**: le nom de domaine peut être une IP | +| **rougail.var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: le nom de domaine peut être une IP
**Défaut**: la valeur de la variable "rougail.var1". | + + diff --git a/tests/docs/base/00_4load_subfolder.adoc b/tests/docs/base/00_4load_subfolder.adoc index 9359433..d025e15 100644 --- a/tests/docs/base/00_4load_subfolder.adoc +++ b/tests/docs/base/00_4load_subfolder.adoc @@ -14,35 +14,19 @@ version: '1.0' var2: description: a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: example - var2: example ----- diff --git a/tests/docs/base/00_4load_subfolder.md b/tests/docs/base/00_4load_subfolder.md index 4160388..083cbf9 100644 --- a/tests/docs/base/00_4load_subfolder.md +++ b/tests/docs/base/00_4load_subfolder.md @@ -18,27 +18,11 @@ version: '1.0' var2: description: a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: example - var2: example -``` diff --git a/tests/docs/base/00_5load_notype.adoc b/tests/docs/base/00_5load_notype.adoc index ee553f0..7490236 100644 --- a/tests/docs/base/00_5load_notype.adoc +++ b/tests/docs/base/00_5load_notype.adoc @@ -7,23 +7,16 @@ without_type: description: a variable default: non ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.without_type** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: non +**Défaut**: non |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - without_type: non ----- diff --git a/tests/docs/base/00_5load_notype.md b/tests/docs/base/00_5load_notype.md index af49633..64a373e 100644 --- a/tests/docs/base/00_5load_notype.md +++ b/tests/docs/base/00_5load_notype.md @@ -11,17 +11,10 @@ without_type: description: a variable default: non ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: non | -# Example with all variables modifiable - -```yaml ---- -rougail: - without_type: non -``` diff --git a/tests/docs/base/00_6boolean.adoc b/tests/docs/base/00_6boolean.adoc index 38edf1b..9751b80 100644 --- a/tests/docs/base/00_6boolean.adoc +++ b/tests/docs/base/00_6boolean.adoc @@ -20,53 +20,41 @@ var6: type: boolean default: false ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="109a,109a",options="header"] +[cols="111a,111a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The first variable. + -**Default**: True +**Défaut**: True | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The second variable. + -**Default**: True +**Défaut**: True | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The third variable. + -**Default**: True +**Défaut**: True | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The forth variable. + -**Default**: False +**Défaut**: False | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The fifth variable. + -**Default**: False +**Défaut**: False | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The sixth variable. + -**Default**: False +**Défaut**: False |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: true - var2: true - var3: true - var4: false - var5: false - var6: false ----- diff --git a/tests/docs/base/00_6boolean.md b/tests/docs/base/00_6boolean.md index 7d448ff..7a0849e 100644 --- a/tests/docs/base/00_6boolean.md +++ b/tests/docs/base/00_6boolean.md @@ -24,27 +24,15 @@ var6: type: boolean default: false ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                    | Description                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: True | -| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: True | -| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: True | -| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: False | -| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: False | -| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: False | +| Variable                                                                                                      | Description                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: True | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: True | +| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: True | +| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: False | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: False | +| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: False | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: true - var2: true - var3: true - var4: false - var5: false - var6: false -``` diff --git a/tests/docs/base/00_6boolean_no_mandatory.adoc b/tests/docs/base/00_6boolean_no_mandatory.adoc index 15bbf20..8b46e61 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.adoc +++ b/tests/docs/base/00_6boolean_no_mandatory.adoc @@ -8,7 +8,7 @@ variable: type: boolean mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" [cols="97a,97a",options="header"] |==== @@ -17,14 +17,7 @@ variable: **rougail.variable** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | A variable. + -**Default**: True +**Défaut**: True |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: true ----- diff --git a/tests/docs/base/00_6boolean_no_mandatory.md b/tests/docs/base/00_6boolean_no_mandatory.md index 8f058a4..e4e3618 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.md +++ b/tests/docs/base/00_6boolean_no_mandatory.md @@ -12,17 +12,10 @@ variable: type: boolean mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | +| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Défaut**: True | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: true -``` diff --git a/tests/docs/base/00_6choice.adoc b/tests/docs/base/00_6choice.adoc index b66be75..9585d53 100644 --- a/tests/docs/base/00_6choice.adoc +++ b/tests/docs/base/00_6choice.adoc @@ -44,86 +44,66 @@ var6: - 3 default: 1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | The first variable. + -**Choices**: +**Choix**: * a * b -* c +* c | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | The second variable. + -**Choices**: +**Choix**: * a * b -* c +* c | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The third variable. + -**Choices**: +**Choix**: * a * b * c -* null +* null | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The forth variable. + -**Choices**: +**Choix**: * null * b -* c +* c | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | The fifth variable. + -**Choices**: +**Choix**: -* a ← (default) +* a ← (defaut) * b -* c +* c | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | The sixth variable. + -**Choices**: +**Choix**: -* 1 ← (default) +* 1 ← (defaut) * 2 -* 3 +* 3 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: a_choice - var2: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: a_choice - var2: a_choice - var3: a_choice - var4: a_choice - var5: a - var6: 1 ----- diff --git a/tests/docs/base/00_6choice.md b/tests/docs/base/00_6choice.md index 8ec6f13..ccebce6 100644 --- a/tests/docs/base/00_6choice.md +++ b/tests/docs/base/00_6choice.md @@ -48,35 +48,15 @@ var6: - 3 default: 1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Choices**:
- a
- b
- c | -| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
**Choices**:
- a
- b
- c | -| **rougail.var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choices**:
- a
- b
- c
- null | -| **rougail.var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choices**:
- null
- b
- c | -| **rougail.var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | -| **rougail.var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
**Choix**:
- a
- b
- c | +| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable.
**Choix**:
- a
- b
- c | +| **rougail.var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choix**:
- a
- b
- c
- null | +| **rougail.var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choix**:
- null
- b
- c | +| **rougail.var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Choix**:
- a ← (defaut)
- b
- c | +| **rougail.var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Choix**:
- 1 ← (defaut)
- 2
- 3 | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: a_choice - var2: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: a_choice - var2: a_choice - var3: a_choice - var4: a_choice - var5: a - var6: 1 -``` diff --git a/tests/docs/base/00_6choice_calculation.adoc b/tests/docs/base/00_6choice_calculation.adoc index b493224..74d714c 100644 --- a/tests/docs/base/00_6choice_calculation.adoc +++ b/tests/docs/base/00_6choice_calculation.adoc @@ -7,7 +7,6 @@ var: description: a variable default: 9 choices: - type: jinja jinja: | {% for n in trange(0, 10) %} {{ n }} @@ -15,24 +14,17 @@ var: return_type: number description: choices is 0 to 9 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A variable. + -**Choices**: choices is 0 to 9. + -**Default**: 9 +**Choix**: choices is 0 to 9. + +**Défaut**: 9 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: 9 ----- diff --git a/tests/docs/base/00_6choice_calculation.md b/tests/docs/base/00_6choice_calculation.md index e6d6bb6..54bbef9 100644 --- a/tests/docs/base/00_6choice_calculation.md +++ b/tests/docs/base/00_6choice_calculation.md @@ -11,7 +11,6 @@ var: description: a variable default: 9 choices: - type: jinja jinja: | {% for n in trange(0, 10) %} {{ n }} @@ -19,17 +18,10 @@ var: return_type: number description: choices is 0 to 9 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**: choices is 0 to 9.
**Défaut**: 9 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: 9 -``` diff --git a/tests/docs/base/00_6choice_variable.adoc b/tests/docs/base/00_6choice_variable.adoc index 821b124..53d010f 100644 --- a/tests/docs/base/00_6choice_variable.adoc +++ b/tests/docs/base/00_6choice_variable.adoc @@ -11,40 +11,28 @@ var2: description: a first variable default: a choices: - type: variable variable: _.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: +**Défaut**: * a * b -* c +* c | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A first variable. + -**Choices**: the value of the variable "rougail.var1". + -**Default**: a +**Choix**: la valeur de la variable "rougail.var1". + +**Défaut**: a |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - a - - b - - c - var2: a ----- diff --git a/tests/docs/base/00_6choice_variable.md b/tests/docs/base/00_6choice_variable.md index cab611e..dc63f1a 100644 --- a/tests/docs/base/00_6choice_variable.md +++ b/tests/docs/base/00_6choice_variable.md @@ -15,25 +15,13 @@ var2: description: a first variable default: a choices: - type: variable variable: _.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | -| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "rougail.var1".
**Default**: a | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**:
- a
- b
- c | +| **rougail.var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Choix**: la valeur de la variable "rougail.var1".
**Défaut**: a | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - a - - b - - c - var2: a -``` diff --git a/tests/docs/base/00_6custom.adoc b/tests/docs/base/00_6custom.adoc index f1ea71d..a947478 100644 --- a/tests/docs/base/00_6custom.adoc +++ b/tests/docs/base/00_6custom.adoc @@ -11,35 +11,20 @@ custom2: type: custom default: value ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `obligatoire` | +The first variable. | **rougail.custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `obligatoire` | The seconf variable. + -**Default**: value +**Défaut**: value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - custom1: xxx ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - custom1: xxx - custom2: value ----- diff --git a/tests/docs/base/00_6custom.md b/tests/docs/base/00_6custom.md index 01155b9..7dc0c90 100644 --- a/tests/docs/base/00_6custom.md +++ b/tests/docs/base/00_6custom.md @@ -15,26 +15,11 @@ custom2: type: custom default: value ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The seconf variable.
**Défaut**: value | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - custom1: xxx -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - custom1: xxx - custom2: value -``` diff --git a/tests/docs/base/00_6domainname.adoc b/tests/docs/base/00_6domainname.adoc index 898c179..ce10882 100644 --- a/tests/docs/base/00_6domainname.adoc +++ b/tests/docs/base/00_6domainname.adoc @@ -8,23 +8,16 @@ variable: type: domainname default: my.domain.name ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="112a,112a",options="header"] +[cols="114a,114a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` | A domain name variable. + -**Default**: my.domain.name +**Défaut**: my.domain.name |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: my.domain.name ----- diff --git a/tests/docs/base/00_6domainname.md b/tests/docs/base/00_6domainname.md index 677658f..695426e 100644 --- a/tests/docs/base/00_6domainname.md +++ b/tests/docs/base/00_6domainname.md @@ -12,17 +12,10 @@ variable: type: domainname default: my.domain.name ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                       | Description                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A domain name variable.
**Défaut**: my.domain.name | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: my.domain.name -``` diff --git a/tests/docs/base/00_6domainname_params.adoc b/tests/docs/base/00_6domainname_params.adoc index 6c273f7..7cfcec2 100644 --- a/tests/docs/base/00_6domainname_params.adoc +++ b/tests/docs/base/00_6domainname_params.adoc @@ -10,24 +10,17 @@ variable: params: allow_ip: true ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="112a,112a",options="header"] +[cols="114a,114a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` | A domain name variable. + -**Validator**: the domain name can be an IP + -**Default**: my.domain.name +**Validator**: le nom de domaine peut être une IP + +**Défaut**: my.domain.name |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: my.domain.name ----- diff --git a/tests/docs/base/00_6domainname_params.md b/tests/docs/base/00_6domainname_params.md index 4237c2c..066ab44 100644 --- a/tests/docs/base/00_6domainname_params.md +++ b/tests/docs/base/00_6domainname_params.md @@ -14,17 +14,10 @@ variable: params: allow_ip: true ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                       | Description                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A domain name variable.
**Validator**: le nom de domaine peut être une IP
**Défaut**: my.domain.name | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: my.domain.name -``` diff --git a/tests/docs/base/00_6float.adoc b/tests/docs/base/00_6float.adoc index 27447ba..af3ae7c 100644 --- a/tests/docs/base/00_6float.adoc +++ b/tests/docs/base/00_6float.adoc @@ -20,53 +20,41 @@ var6: type: float default: 10.1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="107a,107a",options="header"] +[cols="109a,109a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The first variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The second variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The third variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The forth variable. + -**Default**: 10.1 +**Défaut**: 10.1 | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The fifth variable. + -**Default**: 10.1 +**Défaut**: 10.1 | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The sixth variable. + -**Default**: 10.1 +**Défaut**: 10.1 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: 0.0 - var2: 0.0 - var3: 0.0 - var4: 10.1 - var5: 10.1 - var6: 10.1 ----- diff --git a/tests/docs/base/00_6float.md b/tests/docs/base/00_6float.md index 1873adb..48433c9 100644 --- a/tests/docs/base/00_6float.md +++ b/tests/docs/base/00_6float.md @@ -24,27 +24,15 @@ var6: type: float default: 10.1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                  | Description                                                                                               | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0.0 | -| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0.0 | -| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0.0 | -| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: 10.1 | -| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | -| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: 0.0 | +| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: 0.0 | +| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: 0.0 | +| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: 10.1 | +| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: 10.1 | +| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: 10.1 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: 0.0 - var2: 0.0 - var3: 0.0 - var4: 10.1 - var5: 10.1 - var6: 10.1 -``` diff --git a/tests/docs/base/00_6number.adoc b/tests/docs/base/00_6number.adoc index a13ed3e..a77d514 100644 --- a/tests/docs/base/00_6number.adoc +++ b/tests/docs/base/00_6number.adoc @@ -20,53 +20,41 @@ var6: type: number default: 10 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The first variable. + -**Default**: 0 +**Défaut**: 0 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The second variable. + -**Default**: 0 +**Défaut**: 0 | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The third variable. + -**Default**: 0 +**Défaut**: 0 | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | This forth variable. + -**Default**: 10 +**Défaut**: 10 | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The fifth variable. + -**Default**: 10 +**Défaut**: 10 | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The sixth variable. + -**Default**: 10 +**Défaut**: 10 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: 0 - var2: 0 - var3: 0 - var4: 10 - var5: 10 - var6: 10 ----- diff --git a/tests/docs/base/00_6number.md b/tests/docs/base/00_6number.md index 46ba71d..3918232 100644 --- a/tests/docs/base/00_6number.md +++ b/tests/docs/base/00_6number.md @@ -24,27 +24,15 @@ var6: type: number default: 10 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0 | -| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0 | -| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0 | -| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | This forth variable.
**Default**: 10 | -| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | -| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: 0 | +| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: 0 | +| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: 0 | +| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | This forth variable.
**Défaut**: 10 | +| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: 10 | +| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: 10 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: 0 - var2: 0 - var3: 0 - var4: 10 - var5: 10 - var6: 10 -``` diff --git a/tests/docs/base/00_6port.adoc b/tests/docs/base/00_6port.adoc new file mode 100644 index 0000000..1066316 --- /dev/null +++ b/tests/docs/base/00_6port.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +---- +== Variables pour "rougail" + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**rougail.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `obligatoire` | +A port variable. +| +**rougail.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `obligatoire` | +A port variable with default value. + +**Défaut**: 8080 +| +**rougail.variable3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `obligatoire` | +A port variable with integer default value. + +**Défaut**: 8080 +|==== + + diff --git a/tests/docs/base/00_6port.md b/tests/docs/base/00_6port.md new file mode 100644 index 0000000..95b5342 --- /dev/null +++ b/tests/docs/base/00_6port.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +``` +# Variables pour "rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A port variable. | +| **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A port variable with default value.
**Défaut**: 8080 | +| **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A port variable with integer default value.
**Défaut**: 8080 | + + diff --git a/tests/docs/base/00_6regexp.adoc b/tests/docs/base/00_6regexp.adoc new file mode 100644 index 0000000..0c1f649 --- /dev/null +++ b/tests/docs/base/00_6regexp.adoc @@ -0,0 +1,27 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +---- +== Variables pour "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `obligatoire` | +A first variable. + +**Défaut**: #a1a1a1 + +**Exemple**: #b1b1b1 +|==== + + diff --git a/tests/docs/base/00_6regexp.md b/tests/docs/base/00_6regexp.md new file mode 100644 index 0000000..4145b8c --- /dev/null +++ b/tests/docs/base/00_6regexp.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +``` +# Variables pour "rougail" + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: #a1a1a1
**Exemple**: #b1b1b1 | + + diff --git a/tests/docs/base/00_6string.adoc b/tests/docs/base/00_6string.adoc index fe4b52e..ecdada3 100644 --- a/tests/docs/base/00_6string.adoc +++ b/tests/docs/base/00_6string.adoc @@ -19,59 +19,38 @@ var6: type: string default: value ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The first variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The second variable. | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The third variable. | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The forth variable. + -**Default**: value +**Défaut**: value | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The fifth variable. + -**Default**: value +**Défaut**: value | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The sixth variable. + -**Default**: value +**Défaut**: value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example - var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: example - var2: example - var3: example - var4: value - var5: value - var6: value ----- diff --git a/tests/docs/base/00_6string.md b/tests/docs/base/00_6string.md index 1b5e4fc..ef095fa 100644 --- a/tests/docs/base/00_6string.md +++ b/tests/docs/base/00_6string.md @@ -23,36 +23,15 @@ var6: type: string default: value ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: value | -| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | -| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable. | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: value | +| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: value | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: value | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example - var3: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: example - var2: example - var3: example - var4: value - var5: value - var6: value -``` diff --git a/tests/docs/base/00_7choice_quote.adoc b/tests/docs/base/00_7choice_quote.adoc index f007ffe..3c64361 100644 --- a/tests/docs/base/00_7choice_quote.adoc +++ b/tests/docs/base/00_7choice_quote.adoc @@ -12,27 +12,20 @@ var: - quote" - quote"' ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A choice. + -**Choices**: +**Choix**: -* quote' ← (default) +* quote' ← (defaut) * quote" -* quote"' +* quote"' |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: quote' ----- diff --git a/tests/docs/base/00_7choice_quote.md b/tests/docs/base/00_7choice_quote.md index 7e4f5b0..e0ae92e 100644 --- a/tests/docs/base/00_7choice_quote.md +++ b/tests/docs/base/00_7choice_quote.md @@ -16,17 +16,10 @@ var: - quote" - quote"' ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A choice.
**Choix**:
- quote' ← (defaut)
- quote"
- quote"' | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: quote' -``` diff --git a/tests/docs/base/00_7help_quote.adoc b/tests/docs/base/00_7help_quote.adoc index 0f0f189..e30a02e 100644 --- a/tests/docs/base/00_7help_quote.adoc +++ b/tests/docs/base/00_7help_quote.adoc @@ -10,37 +10,21 @@ var2: description: the second variable help: message with " ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The first variable. + -Message with '. +Message with '. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The second variable. + -Message with ". +Message with ". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: example - var2: example ----- diff --git a/tests/docs/base/00_7help_quote.md b/tests/docs/base/00_7help_quote.md index 2c8a93f..878c926 100644 --- a/tests/docs/base/00_7help_quote.md +++ b/tests/docs/base/00_7help_quote.md @@ -14,27 +14,11 @@ var2: description: the second variable help: message with " ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
Message with '. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable.
Message with ". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: example - var2: example -``` diff --git a/tests/docs/base/00_7value_doublequote.adoc b/tests/docs/base/00_7value_doublequote.adoc index ac709d0..8db4183 100644 --- a/tests/docs/base/00_7value_doublequote.adoc +++ b/tests/docs/base/00_7value_doublequote.adoc @@ -7,23 +7,16 @@ variable: description: a variable default: quote" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote" +**Défaut**: quote" |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: quote" ----- diff --git a/tests/docs/base/00_7value_doublequote.md b/tests/docs/base/00_7value_doublequote.md index ea20845..65a5175 100644 --- a/tests/docs/base/00_7value_doublequote.md +++ b/tests/docs/base/00_7value_doublequote.md @@ -11,17 +11,10 @@ variable: description: a variable default: quote" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote" | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: quote" -``` diff --git a/tests/docs/base/00_7value_doublequote2.adoc b/tests/docs/base/00_7value_doublequote2.adoc index 3962c76..3c2bdb7 100644 --- a/tests/docs/base/00_7value_doublequote2.adoc +++ b/tests/docs/base/00_7value_doublequote2.adoc @@ -7,23 +7,16 @@ variable: description: a variable default: quote'" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote'" +**Défaut**: quote'" |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: quote'" ----- diff --git a/tests/docs/base/00_7value_doublequote2.md b/tests/docs/base/00_7value_doublequote2.md index cb2650c..acde101 100644 --- a/tests/docs/base/00_7value_doublequote2.md +++ b/tests/docs/base/00_7value_doublequote2.md @@ -11,17 +11,10 @@ variable: description: a variable default: quote'" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote'" | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: quote'" -``` diff --git a/tests/docs/base/00_7value_doublequote3.adoc b/tests/docs/base/00_7value_doublequote3.adoc index dcee9ff..e6e7543 100644 --- a/tests/docs/base/00_7value_doublequote3.adoc +++ b/tests/docs/base/00_7value_doublequote3.adoc @@ -2,9 +2,22 @@ [,yaml] ---- -version: '1.0' +version: '1.1' + variable: description: a variable - hidden: true default: quote\"\' ---- +== Variables pour "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A variable. + +**Défaut**: quote\"\' +|==== + + diff --git a/tests/docs/base/00_7value_doublequote3.md b/tests/docs/base/00_7value_doublequote3.md index 391ed13..418249c 100644 --- a/tests/docs/base/00_7value_doublequote3.md +++ b/tests/docs/base/00_7value_doublequote3.md @@ -6,9 +6,16 @@ include_toc: true ```yaml --- -version: '1.0' +version: '1.1' + variable: description: a variable - hidden: true default: quote\"\' ``` +# Variables pour "rougail" + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote\"\' | + + diff --git a/tests/docs/base/00_7value_quote.adoc b/tests/docs/base/00_7value_quote.adoc index 772f4f6..b8d14e8 100644 --- a/tests/docs/base/00_7value_quote.adoc +++ b/tests/docs/base/00_7value_quote.adoc @@ -7,23 +7,16 @@ variable: description: a variable default: quote' ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote' +**Défaut**: quote' |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: quote' ----- diff --git a/tests/docs/base/00_7value_quote.md b/tests/docs/base/00_7value_quote.md index 9113259..aecd05e 100644 --- a/tests/docs/base/00_7value_quote.md +++ b/tests/docs/base/00_7value_quote.md @@ -11,17 +11,10 @@ variable: description: a variable default: quote' ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote' | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: quote' -``` diff --git a/tests/docs/base/00_8calculation_information.adoc b/tests/docs/base/00_8calculation_information.adoc index 5794bcf..48f170a 100644 --- a/tests/docs/base/00_8calculation_information.adoc +++ b/tests/docs/base/00_8calculation_information.adoc @@ -6,7 +6,6 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: | {{test_information }} params: @@ -15,30 +14,16 @@ variable: information: test_information description: get information test_information ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: get information test_information. +**Défaut**: get information test_information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: example ----- diff --git a/tests/docs/base/00_8calculation_information.md b/tests/docs/base/00_8calculation_information.md index a7d8623..ddbed1d 100644 --- a/tests/docs/base/00_8calculation_information.md +++ b/tests/docs/base/00_8calculation_information.md @@ -10,7 +10,6 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: | {{test_information }} params: @@ -19,24 +18,10 @@ variable: information: test_information description: get information test_information ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: get information test_information. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: example -``` diff --git a/tests/docs/base/00_8test.adoc b/tests/docs/base/00_8test.adoc index 1c8a433..e82bd17 100644 --- a/tests/docs/base/00_8test.adoc +++ b/tests/docs/base/00_8test.adoc @@ -3,83 +3,85 @@ [,yaml] ---- version: '1.1' + var1: description: the first variable test: - test + var2: description: the second variable test: - test default: value + var3: description: the third variable test: - test1 - test2 + var4: description: the forth variable test: - - test1 - test2 + mandatory: false + var5: description: the fifth variable + type: boolean test: - false ----- -== Variables for "rougail" -[cols="105a,105a",options="header"] +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 +---- +== Variables pour "rougail" + +[cols="127a,127a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The first variable. + -**Example**: test +**Exemple**: test | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The second variable. + -**Default**: value + -**Example**: test +**Défaut**: value + +**Exemple**: test | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The third variable. + -**Example**: test1 +**Exemple**: test1 | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | The forth variable. + -**Example**: None +**Exemple**: None | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The fifth variable. + -**Example**: False +**Défaut**: True + +**Exemple**: False +| +**rougail.var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The sixth variable. + +**Exemples**: + +* test1 +* test2 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: test - var2: test - var3: test1 - var5: false ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: test - var2: test - var3: test1 - var4: - var5: false ----- diff --git a/tests/docs/base/00_8test.md b/tests/docs/base/00_8test.md index 7782e75..12e29fe 100644 --- a/tests/docs/base/00_8test.md +++ b/tests/docs/base/00_8test.md @@ -7,60 +7,54 @@ include_toc: true ```yaml --- version: '1.1' + var1: description: the first variable test: - test + var2: description: the second variable test: - test default: value + var3: description: the third variable test: - test1 - test2 + var4: description: the forth variable test: - - test1 - test2 + mandatory: false + var5: description: the fifth variable + type: boolean test: - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Example**: test | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value
**Example**: test | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Example**: test1 | -| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The forth variable.
**Example**: None | -| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The fifth variable.
**Example**: False | +| Variable                                                                                                                      | Description                                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
**Exemple**: test | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: value
**Exemple**: test | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable.
**Exemple**: test1 | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Exemple**: None | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: True
**Exemple**: False | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The sixth variable.
**Exemples**:
- test1
- test2 | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: test - var2: test - var3: test1 - var5: false -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: test - var2: test - var3: test1 - var4: - var5: false -``` diff --git a/tests/docs/base/00_9choice_variable_multi.adoc b/tests/docs/base/00_9choice_variable_multi.adoc index cc27fc1..4b7eb61 100644 --- a/tests/docs/base/00_9choice_variable_multi.adoc +++ b/tests/docs/base/00_9choice_variable_multi.adoc @@ -19,16 +19,16 @@ variable2: - val1 - val2 ---- -== Variables for "rougail" +== Variables pour "rougail" [cols="116a,116a",options="header"] |==== | Variable | Description | **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` `unique` `multiple` | A first variable. + -**Choices**: +**Choix**: * val1 * val2 @@ -36,28 +36,10 @@ A first variable. + **rougail.variable2** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | A second variable. + -**Choices**: +**Choix**: * val1 * val2 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable1: - - a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable1: - - a_choice - variable2: - - a_choice ----- diff --git a/tests/docs/base/00_9choice_variable_multi.md b/tests/docs/base/00_9choice_variable_multi.md index 8a049fb..2bc8b3f 100644 --- a/tests/docs/base/00_9choice_variable_multi.md +++ b/tests/docs/base/00_9choice_variable_multi.md @@ -23,29 +23,11 @@ variable2: - val1 - val2 ``` -# Variables for "rougail" +# Variables pour "rougail" | Variable                                                                                                           | Description                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | -| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | +| **rougail.variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first variable.
**Choix**:
- val1
- val2 | +| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choix**:
- val1
- val2 | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable1: - - a_choice -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable1: - - a_choice - variable2: - - a_choice -``` diff --git a/tests/docs/base/00_9choice_variables.adoc b/tests/docs/base/00_9choice_variables.adoc index a37a3ba..2b49ba1 100644 --- a/tests/docs/base/00_9choice_variables.adoc +++ b/tests/docs/base/00_9choice_variables.adoc @@ -9,46 +9,35 @@ my_variable: description: a variable type: choice choices: - - type: variable - variable: rougail.source_variable_1 - - type: variable - variable: rougail.source_variable_2 + - variable: _.source_variable_1 + - variable: _.source_variable_2 default: val1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.source_variable_1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The first source variable. + -**Default**: val1 +**Défaut**: val1 | **rougail.source_variable_2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The second source variable. + -**Default**: val2 +**Défaut**: val2 | **rougail.my_variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A variable. + -**Choices**: +**Choix**: -* the value of the variable "rougail.source_variable_1". -* the value of the variable "rougail.source_variable_2". +* la valeur de la variable "rougail.source_variable_1". +* la valeur de la variable "rougail.source_variable_2". -**Default**: val1 +**Défaut**: val1 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - source_variable_1: val1 - source_variable_2: val2 - my_variable: val1 ----- diff --git a/tests/docs/base/00_9choice_variables.md b/tests/docs/base/00_9choice_variables.md index 7880074..e47ca26 100644 --- a/tests/docs/base/00_9choice_variables.md +++ b/tests/docs/base/00_9choice_variables.md @@ -13,27 +13,16 @@ my_variable: description: a variable type: choice choices: - - type: variable - variable: rougail.source_variable_1 - - type: variable - variable: rougail.source_variable_2 + - variable: _.source_variable_1 + - variable: _.source_variable_2 default: val1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                                 | Description                                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | -| **rougail.source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | -| **rougail.my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "rougail.source_variable_1".
- the value of the variable "rougail.source_variable_2".
**Default**: val1 | +| Variable                                                                                                                             | Description                                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first source variable.
**Défaut**: val1 | +| **rougail.source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second source variable.
**Défaut**: val2 | +| **rougail.my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**:
- la valeur de la variable "rougail.source_variable_1".
- la valeur de la variable "rougail.source_variable_2".
**Défaut**: val1 | -# Example with all variables modifiable - -```yaml ---- -rougail: - source_variable_1: val1 - source_variable_2: val2 - my_variable: val1 -``` diff --git a/tests/docs/base/00_9default_calculation.adoc b/tests/docs/base/00_9default_calculation.adoc index 141e89e..fec5d43 100644 --- a/tests/docs/base/00_9default_calculation.adoc +++ b/tests/docs/base/00_9default_calculation.adoc @@ -3,10 +3,10 @@ [,yaml] ---- version: '1.1' + variable: description: a variable default: - type: jinja jinja: | {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} params: @@ -16,23 +16,16 @@ variable: param4: description: concat all parameters ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: concat all parameters. +**Défaut**: concat all parameters. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: string_1_True_None ----- diff --git a/tests/docs/base/00_9default_calculation.md b/tests/docs/base/00_9default_calculation.md index db63626..1d783a2 100644 --- a/tests/docs/base/00_9default_calculation.md +++ b/tests/docs/base/00_9default_calculation.md @@ -7,10 +7,10 @@ include_toc: true ```yaml --- version: '1.1' + variable: description: a variable default: - type: jinja jinja: | {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} params: @@ -20,17 +20,10 @@ variable: param4: description: concat all parameters ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: concat all parameters. | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: string_1_True_None -``` diff --git a/tests/docs/base/00_9default_calculation_information.adoc b/tests/docs/base/00_9default_calculation_information.adoc index 3a58670..011aa0c 100644 --- a/tests/docs/base/00_9default_calculation_information.adoc +++ b/tests/docs/base/00_9default_calculation_information.adoc @@ -6,7 +6,6 @@ version: '1.1' var: description: a variable default: - type: jinja jinja: '{{ information }}' params: information: @@ -15,30 +14,16 @@ var: variable: _.var description: returns the information ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: returns the information. +**Défaut**: returns the information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: example ----- diff --git a/tests/docs/base/00_9default_calculation_information.md b/tests/docs/base/00_9default_calculation_information.md index 275342f..c4b1a37 100644 --- a/tests/docs/base/00_9default_calculation_information.md +++ b/tests/docs/base/00_9default_calculation_information.md @@ -10,7 +10,6 @@ version: '1.1' var: description: a variable default: - type: jinja jinja: '{{ information }}' params: information: @@ -19,24 +18,10 @@ var: variable: _.var description: returns the information ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: returns the information. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: example -``` diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.adoc b/tests/docs/base/00_9default_calculation_information_other_variable.adoc index 82be87a..a77ef11 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.adoc +++ b/tests/docs/base/00_9default_calculation_information_other_variable.adoc @@ -7,7 +7,6 @@ var1: # a first variable var2: description: a second variable default: - type: jinja jinja: | {{ information }} params: @@ -16,36 +15,20 @@ var2: information: test_information variable: _.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: issu d'un calcul. +**Défaut**: depends on a calculation. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: example - var2: example ----- diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.md b/tests/docs/base/00_9default_calculation_information_other_variable.md index 9667d51..d2ff403 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.md +++ b/tests/docs/base/00_9default_calculation_information_other_variable.md @@ -11,7 +11,6 @@ var1: # a first variable var2: description: a second variable default: - type: jinja jinja: | {{ information }} params: @@ -20,27 +19,11 @@ var2: information: test_information variable: _.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: issu d'un calcul. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: depends on a calculation. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: example - var2: example -``` diff --git a/tests/docs/base/00_9default_calculation_multi_optional.adoc b/tests/docs/base/00_9default_calculation_multi_optional.adoc new file mode 100644 index 0000000..dc2d073 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +My_variable. + +**Défaut**: val1 +| +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: + +* la valeur de la variable "rougail.my_variable". +|==== + + diff --git a/tests/docs/base/00_9default_calculation_multi_optional.md b/tests/docs/base/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..a350963 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | My_variable.
**Défaut**: val1 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**:
- la valeur de la variable "rougail.my_variable". | + + diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.adoc b/tests/docs/base/00_9default_calculation_multi_optional2.adoc new file mode 100644 index 0000000..75213d7 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional2.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +My_variable. + +**Défaut**: val1 +| +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: + +* la valeur de la variable "rougail.my_variable_unexists". +|==== + + diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.md b/tests/docs/base/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..3f3f6a2 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_multi_optional2.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | My_variable.
**Défaut**: val1 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**:
- la valeur de la variable "rougail.my_variable_unexists". | + + diff --git a/tests/docs/base/00_9default_calculation_optional.adoc b/tests/docs/base/00_9default_calculation_optional.adoc new file mode 100644 index 0000000..8a98538 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional.adoc @@ -0,0 +1,23 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. +|==== + + diff --git a/tests/docs/base/00_9default_calculation_optional.md b/tests/docs/base/00_9default_calculation_optional.md new file mode 100644 index 0000000..2435633 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable. | + + diff --git a/tests/docs/base/00_9default_calculation_optional_exists.adoc b/tests/docs/base/00_9default_calculation_optional_exists.adoc new file mode 100644 index 0000000..644ad92 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional_exists.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_variable. + +**Défaut**: + +* val1 +* val2 +| +**rougail.my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: la valeur de la variable "rougail.my_variable". +|==== + + diff --git a/tests/docs/base/00_9default_calculation_optional_exists.md b/tests/docs/base/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..90fb029 --- /dev/null +++ b/tests/docs/base/00_9default_calculation_optional_exists.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_variable.
**Défaut**:
- val1
- val2 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**: la valeur de la variable "rougail.my_variable". | + + diff --git a/tests/docs/base/00_9default_calculation_param_optional.adoc b/tests/docs/base/00_9default_calculation_param_optional.adoc index 5169601..f966000 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.adoc +++ b/tests/docs/base/00_9default_calculation_param_optional.adoc @@ -6,49 +6,37 @@ version: '1.1' var1: description: a first variable default: - type: jinja jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' params: var2: - type: variable variable: _.var2 optional: true var3: - type: variable variable: _.var3 optional: true var4: - type: variable variable: _.unknown_family.var optional: true description: returns a value mandatory: false var2: no # a second variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A first variable. + -**Default**: returns a value. +**Défaut**: returns a value. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: no ----- diff --git a/tests/docs/base/00_9default_calculation_param_optional.md b/tests/docs/base/00_9default_calculation_param_optional.md index 9dc2c6e..9dfa657 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.md +++ b/tests/docs/base/00_9default_calculation_param_optional.md @@ -10,39 +10,27 @@ version: '1.1' var1: description: a first variable default: - type: jinja jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' params: var2: - type: variable variable: _.var2 optional: true var3: - type: variable variable: _.var3 optional: true var4: - type: variable variable: _.unknown_family.var optional: true description: returns a value mandatory: false var2: no # a second variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Default**: returns a value. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Défaut**: returns a value. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: no -``` diff --git a/tests/docs/base/00_9default_information_other_variable.adoc b/tests/docs/base/00_9default_information_other_variable.adoc index 7608b55..4808840 100644 --- a/tests/docs/base/00_9default_information_other_variable.adoc +++ b/tests/docs/base/00_9default_information_other_variable.adoc @@ -11,36 +11,20 @@ var2: information: test_information variable: _.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: value of the information. +**Défaut**: la valeur de information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: example - var2: example ----- diff --git a/tests/docs/base/00_9default_information_other_variable.md b/tests/docs/base/00_9default_information_other_variable.md index 8e98b02..fe8d11f 100644 --- a/tests/docs/base/00_9default_information_other_variable.md +++ b/tests/docs/base/00_9default_information_other_variable.md @@ -15,27 +15,11 @@ var2: information: test_information variable: _.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: la valeur de information. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: example - var2: example -``` diff --git a/tests/docs/base/00_9default_integer.adoc b/tests/docs/base/00_9default_integer.adoc index 5f47ba0..29aad28 100644 --- a/tests/docs/base/00_9default_integer.adoc +++ b/tests/docs/base/00_9default_integer.adoc @@ -5,10 +5,8 @@ version: '1.1' var: description: a variable - type: choice default: 9 choices: - type: jinja jinja: | {% for item in trange(0, 10) %} {{ item }} @@ -16,24 +14,17 @@ var: return_type: number description: choice for 0 to 9 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A variable. + -**Choices**: choice for 0 to 9. + -**Default**: 9 +**Choix**: choice for 0 to 9. + +**Défaut**: 9 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: 9 ----- diff --git a/tests/docs/base/00_9default_integer.md b/tests/docs/base/00_9default_integer.md index d432416..26ca785 100644 --- a/tests/docs/base/00_9default_integer.md +++ b/tests/docs/base/00_9default_integer.md @@ -9,10 +9,8 @@ include_toc: true version: '1.1' var: description: a variable - type: choice default: 9 choices: - type: jinja jinja: | {% for item in trange(0, 10) %} {{ item }} @@ -20,17 +18,10 @@ var: return_type: number description: choice for 0 to 9 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**: choice for 0 to 9.
**Défaut**: 9 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: 9 -``` diff --git a/tests/docs/base/00_9extra.adoc b/tests/docs/base/00_9extra.adoc index e9d78a4..0cb7f7e 100644 --- a/tests/docs/base/00_9extra.adoc +++ b/tests/docs/base/00_9extra.adoc @@ -13,42 +13,32 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: return no ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: rougail +**Défaut**: rougail |==== -== Variables for "extra" +== Variables pour "extra" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **extra.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: return no. +**Défaut**: return no. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: rougail -extra: - variable: no ----- diff --git a/tests/docs/base/00_9extra.md b/tests/docs/base/00_9extra.md index 6e95961..75c7388 100644 --- a/tests/docs/base/00_9extra.md +++ b/tests/docs/base/00_9extra.md @@ -17,30 +17,20 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: return no ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: rougail | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: rougail | -# Variables for "extra" +# Variables pour "extra" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: return no. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: return no. | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: rougail -extra: - variable: no -``` diff --git a/tests/docs/base/00_9extra_calculation.adoc b/tests/docs/base/00_9extra_calculation.adoc index ba1a965..c6e560f 100644 --- a/tests/docs/base/00_9extra_calculation.adoc +++ b/tests/docs/base/00_9extra_calculation.adoc @@ -13,71 +13,56 @@ version: '1.1' variable1: description: a first variable default: - type: variable variable: rougail.variable variable2: description: a second variable default: - type: jinja jinja: | {{ rougail.variable }} description: copy the value of rougail.variable variable3: description: a third variable default: - type: jinja jinja: | {{ variable }} params: variable: - type: variable variable: rougail.variable description: copy the value of rougail.variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: value +**Défaut**: value |==== -== Variables for "extra" +== Variables pour "extra" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **extra.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: the value of the variable "rougail.variable". +**Défaut**: la valeur de la variable "rougail.variable". | **extra.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: copy the value of rougail.variable. +**Défaut**: copy the value of rougail.variable. | **extra.variable3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A third variable. + -**Default**: copy the value of rougail.variable. +**Défaut**: copy the value of rougail.variable. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: value -extra: - variable1: value - variable2: value - variable3: value ----- diff --git a/tests/docs/base/00_9extra_calculation.md b/tests/docs/base/00_9extra_calculation.md index 6b70529..247cd76 100644 --- a/tests/docs/base/00_9extra_calculation.md +++ b/tests/docs/base/00_9extra_calculation.md @@ -17,51 +17,36 @@ version: '1.1' variable1: description: a first variable default: - type: variable variable: rougail.variable variable2: description: a second variable default: - type: jinja jinja: | {{ rougail.variable }} description: copy the value of rougail.variable variable3: description: a third variable default: - type: jinja jinja: | {{ variable }} params: variable: - type: variable variable: rougail.variable description: copy the value of rougail.variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: value | -# Variables for "extra" +# Variables pour "extra" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: the value of the variable "rougail.variable". | -| **extra.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: copy the value of rougail.variable. | -| **extra.variable3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: copy the value of rougail.variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: la valeur de la variable "rougail.variable". | +| **extra.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: copy the value of rougail.variable. | +| **extra.variable3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: copy the value of rougail.variable. | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: value -extra: - variable1: value - variable2: value - variable3: value -``` diff --git a/tests/docs/base/01_6boolean_multi.adoc b/tests/docs/base/01_6boolean_multi.adoc index 7e5b04a..a5e0a44 100644 --- a/tests/docs/base/01_6boolean_multi.adoc +++ b/tests/docs/base/01_6boolean_multi.adoc @@ -38,89 +38,67 @@ var8: default: - true ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="129a,129a",options="header"] +[cols="131a,131a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* true +* true | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* true +* true | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* true +* true | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* false +* false | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* false +* false | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* false +* false | **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* true +* true | **rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* true +* true |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - true - var2: - - true - var3: - - true - var4: - - false - var5: - - false - var6: - - false - var7: - - true - var8: - - true ----- diff --git a/tests/docs/base/01_6boolean_multi.md b/tests/docs/base/01_6boolean_multi.md index d0e3ed6..cbaa699 100644 --- a/tests/docs/base/01_6boolean_multi.md +++ b/tests/docs/base/01_6boolean_multi.md @@ -42,39 +42,17 @@ var8: default: - true ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                        | Description                                                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- true | -| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- true | -| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- true | -| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- false | -| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- false | -| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- false | -| **rougail.var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- true | -| **rougail.var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- true | +| Variable                                                                                                                          | Description                                                                                                                       | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- true | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- true | +| **rougail.var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- true | +| **rougail.var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- false | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- false | +| **rougail.var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- false | +| **rougail.var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- true | +| **rougail.var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- true | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - true - var2: - - true - var3: - - true - var4: - - false - var5: - - false - var6: - - false - var7: - - true - var8: - - true -``` diff --git a/tests/docs/base/01_6custom_multi.adoc b/tests/docs/base/01_6custom_multi.adoc index f51cc8d..f37b81a 100644 --- a/tests/docs/base/01_6custom_multi.adoc +++ b/tests/docs/base/01_6custom_multi.adoc @@ -13,40 +13,22 @@ custom2: default: - value ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | -A first custom variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `obligatoire` `unique` `multiple` | +A first custom variable. | **rougail.custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `obligatoire` `unique` `multiple` | A second custom variable. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - custom1: - - xxx ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - custom1: - - xxx - custom2: - - value ----- diff --git a/tests/docs/base/01_6custom_multi.md b/tests/docs/base/01_6custom_multi.md index be4fdef..c8252fb 100644 --- a/tests/docs/base/01_6custom_multi.md +++ b/tests/docs/base/01_6custom_multi.md @@ -17,29 +17,11 @@ custom2: default: - value ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | -| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first custom variable. | +| **rougail.custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second custom variable.
**Défaut**:
- value | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - custom1: - - xxx -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - custom1: - - xxx - custom2: - - value -``` diff --git a/tests/docs/base/01_6float_multi.adoc b/tests/docs/base/01_6float_multi.adoc index 063a825..ea845a2 100644 --- a/tests/docs/base/01_6float_multi.adoc +++ b/tests/docs/base/01_6float_multi.adoc @@ -38,89 +38,67 @@ var8: default: - 0.0 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="127a,127a",options="header"] +[cols="129a,129a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - 0.0 - var2: - - 0.0 - var3: - - 0.0 - var4: - - 10.1 - var5: - - 10.1 - var6: - - 10.1 - var7: - - 0.0 - var8: - - 0.0 ----- diff --git a/tests/docs/base/01_6float_multi.md b/tests/docs/base/01_6float_multi.md index ab1d99b..2cb7158 100644 --- a/tests/docs/base/01_6float_multi.md +++ b/tests/docs/base/01_6float_multi.md @@ -42,39 +42,17 @@ var8: default: - 0.0 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                      | Description                                                                                                                   | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0.0 | -| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0.0 | -| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0.0 | -| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10.1 | -| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10.1 | -| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10.1 | -| **rougail.var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0.0 | -| **rougail.var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0.0 | +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- 0.0 | +| **rougail.var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- 0.0 | +| **rougail.var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- 0.0 | +| **rougail.var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- 10.1 | +| **rougail.var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- 10.1 | +| **rougail.var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- 10.1 | +| **rougail.var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- 0.0 | +| **rougail.var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- 0.0 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - 0.0 - var2: - - 0.0 - var3: - - 0.0 - var4: - - 10.1 - var5: - - 10.1 - var6: - - 10.1 - var7: - - 0.0 - var8: - - 0.0 -``` diff --git a/tests/docs/base/01_6number_multi.adoc b/tests/docs/base/01_6number_multi.adoc index f67c5e2..6df2f7e 100644 --- a/tests/docs/base/01_6number_multi.adoc +++ b/tests/docs/base/01_6number_multi.adoc @@ -38,89 +38,67 @@ var8: default: - 0 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* 0 +* 0 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - 0 - var2: - - 0 - var3: - - 0 - var4: - - 10 - var5: - - 10 - var6: - - 10 - var7: - - 0 - var8: - - 0 ----- diff --git a/tests/docs/base/01_6number_multi.md b/tests/docs/base/01_6number_multi.md index 2038dce..52d6a0a 100644 --- a/tests/docs/base/01_6number_multi.md +++ b/tests/docs/base/01_6number_multi.md @@ -42,39 +42,17 @@ var8: default: - 0 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0 | -| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0 | -| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0 | -| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10 | -| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10 | -| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10 | -| **rougail.var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0 | -| **rougail.var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0 | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- 0 | +| **rougail.var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- 0 | +| **rougail.var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- 0 | +| **rougail.var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- 10 | +| **rougail.var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- 10 | +| **rougail.var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- 10 | +| **rougail.var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- 0 | +| **rougail.var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- 0 | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - 0 - var2: - - 0 - var3: - - 0 - var4: - - 10 - var5: - - 10 - var6: - - 10 - var7: - - 0 - var8: - - 0 -``` diff --git a/tests/docs/base/01_6string_empty.adoc b/tests/docs/base/01_6string_empty.adoc new file mode 100644 index 0000000..d317b55 --- /dev/null +++ b/tests/docs/base/01_6string_empty.adoc @@ -0,0 +1,26 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: the second variable + empty: false + default: [value, None] +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +The second variable. + +**Défaut**: + +* value +* None +|==== + + diff --git a/tests/docs/base/01_6string_empty.md b/tests/docs/base/01_6string_empty.md new file mode 100644 index 0000000..4c4e11c --- /dev/null +++ b/tests/docs/base/01_6string_empty.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the second variable + empty: false + default: [value, None] +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- value
- None | + + diff --git a/tests/docs/base/01_6string_multi.adoc b/tests/docs/base/01_6string_multi.adoc index dbd0a5d..20af947 100644 --- a/tests/docs/base/01_6string_multi.adoc +++ b/tests/docs/base/01_6string_multi.adoc @@ -34,90 +34,58 @@ var8: default: - value ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The first variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The second variable. | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The third variable. | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* value +* value | **rougail.var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* value +* value | **rougail.var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* value +* value | **rougail.var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* value +* value | **rougail.var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: - - example - var2: - - example - var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - example - var2: - - example - var3: example - var4: - - value - var5: - - value - var6: - - value - var7: - - value - var8: - - value ----- diff --git a/tests/docs/base/01_6string_multi.md b/tests/docs/base/01_6string_multi.md index 955c9f3..fd2b5dc 100644 --- a/tests/docs/base/01_6string_multi.md +++ b/tests/docs/base/01_6string_multi.md @@ -38,49 +38,17 @@ var8: default: - value ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- value | -| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- value | -| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- value | -| **rougail.var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- value | -| **rougail.var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- value | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The first variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The second variable. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable. | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- value | +| **rougail.var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- value | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- value | +| **rougail.var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- value | +| **rougail.var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- value | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: - - example - var2: - - example - var3: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - example - var2: - - example - var3: example - var4: - - value - var5: - - value - var6: - - value - var7: - - value - var8: - - value -``` diff --git a/tests/docs/base/01_7value_multi_doublequote.adoc b/tests/docs/base/01_7value_multi_doublequote.adoc index c62da50..409dc56 100644 --- a/tests/docs/base/01_7value_multi_doublequote.adoc +++ b/tests/docs/base/01_7value_multi_doublequote.adoc @@ -8,26 +8,18 @@ variable: default: - quote" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote" +* quote" |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - quote" ----- diff --git a/tests/docs/base/01_7value_multi_doublequote.md b/tests/docs/base/01_7value_multi_doublequote.md index 258c1d1..ae1a912 100644 --- a/tests/docs/base/01_7value_multi_doublequote.md +++ b/tests/docs/base/01_7value_multi_doublequote.md @@ -12,18 +12,10 @@ variable: default: - quote" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote" | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - quote" -``` diff --git a/tests/docs/base/01_7value_multi_doublequote2.adoc b/tests/docs/base/01_7value_multi_doublequote2.adoc index 3f66202..8e5b0f7 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.adoc +++ b/tests/docs/base/01_7value_multi_doublequote2.adoc @@ -8,26 +8,18 @@ variable: default: - quote'" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote'" +* quote'" |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - quote'" ----- diff --git a/tests/docs/base/01_7value_multi_doublequote2.md b/tests/docs/base/01_7value_multi_doublequote2.md index 7e5a49d..815750b 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.md +++ b/tests/docs/base/01_7value_multi_doublequote2.md @@ -12,18 +12,10 @@ variable: default: - quote'" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote'" | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - quote'" -``` diff --git a/tests/docs/base/01_7value_multi_quote.adoc b/tests/docs/base/01_7value_multi_quote.adoc index fa84adb..87d1d99 100644 --- a/tests/docs/base/01_7value_multi_quote.adoc +++ b/tests/docs/base/01_7value_multi_quote.adoc @@ -8,26 +8,18 @@ variable: default: - quote' ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote' +* quote' |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - quote' ----- diff --git a/tests/docs/base/01_7value_multi_quote.md b/tests/docs/base/01_7value_multi_quote.md index 48bf417..27d4193 100644 --- a/tests/docs/base/01_7value_multi_quote.md +++ b/tests/docs/base/01_7value_multi_quote.md @@ -12,18 +12,10 @@ variable: default: - quote' ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote' | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - quote' -``` diff --git a/tests/docs/base/01_8calculation_information_multi.adoc b/tests/docs/base/01_8calculation_information_multi.adoc index 0965b20..68bee10 100644 --- a/tests/docs/base/01_8calculation_information_multi.adoc +++ b/tests/docs/base/01_8calculation_information_multi.adoc @@ -7,7 +7,6 @@ variable: description: a variable multi: true default: - type: jinja jinja: | {{test_information }} params: @@ -16,24 +15,16 @@ variable: information: test_information description: get information test_information ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: get information test_information. +**Défaut**: get information test_information. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - '[]' ----- diff --git a/tests/docs/base/01_8calculation_information_multi.md b/tests/docs/base/01_8calculation_information_multi.md index 6126d63..f27d855 100644 --- a/tests/docs/base/01_8calculation_information_multi.md +++ b/tests/docs/base/01_8calculation_information_multi.md @@ -11,7 +11,6 @@ variable: description: a variable multi: true default: - type: jinja jinja: | {{test_information }} params: @@ -20,18 +19,10 @@ variable: information: test_information description: get information test_information ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**: get information test_information. | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - '[]' -``` diff --git a/tests/docs/base/01_9choice_variable_multi.adoc b/tests/docs/base/01_9choice_variable_multi.adoc index ff21ebe..e2de557 100644 --- a/tests/docs/base/01_9choice_variable_multi.adoc +++ b/tests/docs/base/01_9choice_variable_multi.adoc @@ -10,46 +10,27 @@ variable1: # a first variable variable2: description: a second variable choices: - type: variable variable: _.variable1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: * a * b -* c +* c | **rougail.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A second variable. + -**Choices**: the value of the variable "rougail.variable1". +**Choix**: la valeur de la variable "rougail.variable1". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable2: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable1: - - a - - b - - c - variable2: a_choice ----- diff --git a/tests/docs/base/01_9choice_variable_multi.md b/tests/docs/base/01_9choice_variable_multi.md index cc74f51..f52297a 100644 --- a/tests/docs/base/01_9choice_variable_multi.md +++ b/tests/docs/base/01_9choice_variable_multi.md @@ -14,32 +14,13 @@ variable1: # a first variable variable2: description: a second variable choices: - type: variable variable: _.variable1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | -| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "rougail.variable1". | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- a
- b
- c | +| **rougail.variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second variable.
**Choix**: la valeur de la variable "rougail.variable1". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable2: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable1: - - a - - b - - c - variable2: a_choice -``` diff --git a/tests/docs/base/04_0type_param.adoc b/tests/docs/base/04_0type_param.adoc index ceeb8a9..c9470d6 100644 --- a/tests/docs/base/04_0type_param.adoc +++ b/tests/docs/base/04_0type_param.adoc @@ -5,38 +5,26 @@ version: '1.1' int: description: A limited number - type: number + default: 10 params: min_number: 0 max_number: 100 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A limited number. + **Validators**: -* the minimum value is 0 -* the maximum value is 100 +* le valeur minimal est 0 +* le valeur maximal est 100 + +**Défaut**: 10 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - int: 42 ----- diff --git a/tests/docs/base/04_0type_param.md b/tests/docs/base/04_0type_param.md index 9385a1d..a92d132 100644 --- a/tests/docs/base/04_0type_param.md +++ b/tests/docs/base/04_0type_param.md @@ -9,29 +9,15 @@ include_toc: true version: '1.1' int: description: A limited number - type: number + default: 10 params: min_number: 0 max_number: 100 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A limited number.
**Validators**:
- le valeur minimal est 0
- le valeur maximal est 100
**Défaut**: 10 | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - int: 42 -``` diff --git a/tests/docs/base/04_1auto_save.adoc b/tests/docs/base/04_1auto_save.adoc index f58aacb..d4ef392 100644 --- a/tests/docs/base/04_1auto_save.adoc +++ b/tests/docs/base/04_1auto_save.adoc @@ -8,23 +8,16 @@ variable: auto_save: true default: no ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="121a,121a",options="header"] +[cols="123a,123a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `auto modifiée` | An auto save variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: no ----- diff --git a/tests/docs/base/04_1auto_save.md b/tests/docs/base/04_1auto_save.md index 95705a4..7031094 100644 --- a/tests/docs/base/04_1auto_save.md +++ b/tests/docs/base/04_1auto_save.md @@ -12,17 +12,10 @@ variable: auto_save: true default: no ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | +| Variable                                                                                                                  | Description                                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `auto modifiée` | An auto save variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: no -``` diff --git a/tests/docs/base/04_1auto_save_and_calculated.adoc b/tests/docs/base/04_1auto_save_and_calculated.adoc index daf067b..05da6dc 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated.adoc @@ -8,32 +8,23 @@ var2: description: a second variable auto_save: true default: - type: variable variable: _.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="121a,121a",options="header"] +[cols="123a,123a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `auto modifiée` | A second variable. + -**Default**: the value of the variable "rougail.var1". +**Défaut**: la valeur de la variable "rougail.var1". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: no ----- diff --git a/tests/docs/base/04_1auto_save_and_calculated.md b/tests/docs/base/04_1auto_save_and_calculated.md index b3200d9..eaabbe7 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.md +++ b/tests/docs/base/04_1auto_save_and_calculated.md @@ -12,22 +12,13 @@ var2: description: a second variable auto_save: true default: - type: variable variable: _.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | A second variable.
**Default**: the value of the variable "rougail.var1". | +| Variable                                                                                                                  | Description                                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `auto modifiée` | A second variable.
**Défaut**: la valeur de la variable "rougail.var1". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: no -``` diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc index eff9434..be200d3 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc @@ -8,41 +8,31 @@ var2: description: a second variable auto_save: true hidden: - type: jinja jinja: | {% if _.var1 == "yes" %} _.var1 is yes {% endif %} description: only if the variable var1 has value "yes" default: - type: jinja jinja: yes description: the value is always yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="132a,132a",options="header"] +[cols="133a,133a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`caché`_ `auto modifiée` | A second variable. + -**Default**: the value is always yes. + -**Hidden**: only if the variable var1 has value "yes". +**Défaut**: the value is always yes. + +**Caché**: only if the variable var1 has value "yes". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: yes ----- diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.md b/tests/docs/base/04_1auto_save_and_calculated_hidden.md index b2c38a9..2f240df 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.md +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.md @@ -12,30 +12,20 @@ var2: description: a second variable auto_save: true hidden: - type: jinja jinja: | {% if _.var1 == "yes" %} _.var1 is yes {% endif %} description: only if the variable var1 has value "yes" default: - type: jinja jinja: yes description: the value is always yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                           | Description                                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | +| Variable                                                                                                                            | Description                                                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`caché`_ `auto modifiée` | A second variable.
**Défaut**: the value is always yes.
**Caché**: only if the variable var1 has value "yes". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: yes -``` diff --git a/tests/docs/base/04_1auto_save_and_hidden.adoc b/tests/docs/base/04_1auto_save_and_hidden.adoc index e8bea5c..4dfe262 100644 --- a/tests/docs/base/04_1auto_save_and_hidden.adoc +++ b/tests/docs/base/04_1auto_save_and_hidden.adoc @@ -8,4 +8,5 @@ var: auto_save: true hidden: true default: yes + mandatory: false ---- diff --git a/tests/docs/base/04_1auto_save_and_hidden.md b/tests/docs/base/04_1auto_save_and_hidden.md index 7bbe9eb..eb23d55 100644 --- a/tests/docs/base/04_1auto_save_and_hidden.md +++ b/tests/docs/base/04_1auto_save_and_hidden.md @@ -12,4 +12,5 @@ var: auto_save: true hidden: true default: yes + mandatory: false ``` diff --git a/tests/docs/base/04_1default_calculation_hidden.adoc b/tests/docs/base/04_1default_calculation_hidden.adoc new file mode 100644 index 0000000..be62da1 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +---- +== Variables pour "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A first variable. + +**Défaut**: value +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | +A second variable. + +**Désactivé**: when the variable "rougail.var1" has the value "value". +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A third variable. + +**Défaut**: depends on a calculation. +|==== + + diff --git a/tests/docs/base/04_1default_calculation_hidden.md b/tests/docs/base/04_1default_calculation_hidden.md new file mode 100644 index 0000000..361b5c5 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +``` +# Variables pour "rougail" + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A second variable.
**Désactivé**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: depends on a calculation. | + + diff --git a/tests/docs/base/04_1default_calculation_hidden_2.adoc b/tests/docs/base/04_1default_calculation_hidden_2.adoc new file mode 100644 index 0000000..bbdc3d5 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden_2.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +---- +== Variables pour "rougail" + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A first variable. + +**Défaut**: value +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | +A second variable. + +**Désactivé**: when the variable "rougail.var1" has the value "value". +| +**rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A third variable. + +**Défaut**: depends on a calculation. +|==== + + diff --git a/tests/docs/base/04_1default_calculation_hidden_2.md b/tests/docs/base/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..b7c8441 --- /dev/null +++ b/tests/docs/base/04_1default_calculation_hidden_2.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +``` +# Variables pour "rougail" + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A second variable.
**Désactivé**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: depends on a calculation. | + + diff --git a/tests/docs/base/04_5disabled_calculation.adoc b/tests/docs/base/04_5disabled_calculation.adoc index 5e749e7..864d6b3 100644 --- a/tests/docs/base/04_5disabled_calculation.adoc +++ b/tests/docs/base/04_5disabled_calculation.adoc @@ -7,7 +7,6 @@ condition: no # a conditional variable variable1: description: a first variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -16,50 +15,32 @@ variable1: variable2: description: a second variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is egal to "yes" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A conditional variable. + -**Default**: no +**Défaut**: no | **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A first variable. + -**Disabled**: if condition is egal to "yes". +**Désactivé**: if condition is egal to "yes". | **rougail.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A second variable. + -**Disabled**: if condition is egal to "yes". +**Désactivé**: if condition is egal to "yes". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable1: example - variable2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - variable1: example - variable2: example ----- diff --git a/tests/docs/base/04_5disabled_calculation.md b/tests/docs/base/04_5disabled_calculation.md index c298bc3..641a4ac 100644 --- a/tests/docs/base/04_5disabled_calculation.md +++ b/tests/docs/base/04_5disabled_calculation.md @@ -11,7 +11,6 @@ condition: no # a conditional variable variable1: description: a first variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -20,36 +19,18 @@ variable1: variable2: description: a second variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is egal to "yes" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: no | -| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A first variable.
**Disabled**: if condition is egal to "yes". | -| **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: if condition is egal to "yes". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A conditional variable.
**Défaut**: no | +| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A first variable.
**Désactivé**: if condition is egal to "yes". | +| **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A second variable.
**Désactivé**: if condition is egal to "yes". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable1: example - variable2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - variable1: example - variable2: example -``` diff --git a/tests/docs/base/04_5disabled_calculation_default.adoc b/tests/docs/base/04_5disabled_calculation_default.adoc index 4ae0cef..8584e20 100644 --- a/tests/docs/base/04_5disabled_calculation_default.adoc +++ b/tests/docs/base/04_5disabled_calculation_default.adoc @@ -3,67 +3,57 @@ [,yaml] ---- version: '1.1' + condition: no # a condition + var1: description: a first variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: the value of condition + var2: description: a second variable disabled: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: the value of condition ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="121a,121a",options="header"] +[cols="124a,124a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`désactivé`_ | A first variable. + -**Default**: the value of condition. + -**Disabled**: if condition is yes. +**Défaut**: the value of condition. + +**Désactivé**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`désactivé`_ | A second variable. + -**Default**: the value of condition. + -**Disabled**: if condition is yes. +**Défaut**: the value of condition. + +**Désactivé**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var1: no - var2: no ----- diff --git a/tests/docs/base/04_5disabled_calculation_default.md b/tests/docs/base/04_5disabled_calculation_default.md index d81a726..6dff457 100644 --- a/tests/docs/base/04_5disabled_calculation_default.md +++ b/tests/docs/base/04_5disabled_calculation_default.md @@ -7,51 +7,41 @@ include_toc: true ```yaml --- version: '1.1' + condition: no # a condition + var1: description: a first variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: the value of condition + var2: description: a second variable disabled: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: the value of condition ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A first variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A second variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`désactivé`_ | A first variable.
**Défaut**: the value of condition.
**Désactivé**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`désactivé`_ | A second variable.
**Défaut**: the value of condition.
**Désactivé**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var1: no - var2: no -``` diff --git a/tests/docs/base/04_5disabled_calculation_optional.adoc b/tests/docs/base/04_5disabled_calculation_optional.adoc index a4bf515..5539e9c 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.adoc +++ b/tests/docs/base/04_5disabled_calculation_optional.adoc @@ -7,73 +7,54 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if unknown is not defined %} unknown is undefined {% elif unknown == "no" %} unknown is no {% endif %} - params: - unknown: - type: variable - variable: _.unknown - optional: true + params: + unknown: + variable: _.unknown + optional: true description: calculation from an unknown variable + mandatory: false var2: description: a second variable hidden: - type: jinja jinja: | {% if condition is not defined %} condition is undefined {% elif condition == "no" %} condition is no {% endif %} - params: - condition: - type: variable - variable: _.condition - optional: true + params: + condition: + variable: _.condition + optional: true description: calculation from an condition variable + mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="116a,116a",options="header"] +[cols="106a,106a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`caché`_ | A first variable. + -**Hidden**: calculation from an unknown variable. +**Caché**: calculation from an unknown variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`caché`_ | A second variable. + -**Hidden**: calculation from an condition variable. +**Caché**: calculation from an condition variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var1: example - var2: example ----- diff --git a/tests/docs/base/04_5disabled_calculation_optional.md b/tests/docs/base/04_5disabled_calculation_optional.md index 0acc71f..d711493 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.md +++ b/tests/docs/base/04_5disabled_calculation_optional.md @@ -11,59 +11,40 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if unknown is not defined %} unknown is undefined {% elif unknown == "no" %} unknown is no {% endif %} - params: - unknown: - type: variable - variable: _.unknown - optional: true + params: + unknown: + variable: _.unknown + optional: true description: calculation from an unknown variable + mandatory: false var2: description: a second variable hidden: - type: jinja jinja: | {% if condition is not defined %} condition is undefined {% elif condition == "no" %} condition is no {% endif %} - params: - condition: - type: variable - variable: _.condition - optional: true + params: + condition: + variable: _.condition + optional: true description: calculation from an condition variable + mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`caché`_ | A first variable.
**Caché**: calculation from an unknown variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`caché`_ | A second variable.
**Caché**: calculation from an condition variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var1: example - var2: example -``` diff --git a/tests/docs/base/04_5disabled_calculation_variable.adoc b/tests/docs/base/04_5disabled_calculation_variable.adoc index adeaf56..5a46ee9 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable.adoc @@ -7,39 +7,23 @@ condition: false # a condition variable: description: a variable disabled: - type: variable variable: _.condition ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: False +**Défaut**: False | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "rougail.condition" has the value "True". +**Désactivé**: when the variable "rougail.condition" has the value "True". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: false - variable: example ----- diff --git a/tests/docs/base/04_5disabled_calculation_variable.md b/tests/docs/base/04_5disabled_calculation_variable.md index c33b25a..0a57830 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.md +++ b/tests/docs/base/04_5disabled_calculation_variable.md @@ -11,29 +11,13 @@ condition: false # a condition variable: description: a variable disabled: - type: variable variable: _.condition ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: False | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "rougail.condition" has the value "True". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: false - variable: example -``` diff --git a/tests/docs/base/04_5disabled_calculation_variable2.adoc b/tests/docs/base/04_5disabled_calculation_variable2.adoc index 362a75d..0160852 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable2.adoc @@ -7,39 +7,23 @@ condition: true # a condition variable: description: a variable disabled: - type: variable variable: _.condition ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: True +**Défaut**: True | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "rougail.condition" has the value "True". +**Désactivé**: when the variable "rougail.condition" has the value "True". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: true - variable: example ----- diff --git a/tests/docs/base/04_5disabled_calculation_variable2.md b/tests/docs/base/04_5disabled_calculation_variable2.md index 6cdefa1..204fd48 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.md +++ b/tests/docs/base/04_5disabled_calculation_variable2.md @@ -11,29 +11,13 @@ condition: true # a condition variable: description: a variable disabled: - type: variable variable: _.condition ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: True | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "rougail.condition" has the value "True". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: true - variable: example -``` diff --git a/tests/docs/base/04_5disabled_calculation_variable3.adoc b/tests/docs/base/04_5disabled_calculation_variable3.adoc index 2febb3e..07bb158 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable3.adoc @@ -7,40 +7,24 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when: yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "rougail.condition" has the value "yes". +**Désactivé**: when the variable "rougail.condition" has the value "yes". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: yes - variable: example ----- diff --git a/tests/docs/base/04_5disabled_calculation_variable3.md b/tests/docs/base/04_5disabled_calculation_variable3.md index ac79463..8cceb41 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.md +++ b/tests/docs/base/04_5disabled_calculation_variable3.md @@ -11,30 +11,14 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when: yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "yes". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "rougail.condition" has the value "yes". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: yes - variable: example -``` diff --git a/tests/docs/base/04_5disabled_calculation_variable4.adoc b/tests/docs/base/04_5disabled_calculation_variable4.adoc index f170e05..7fd2185 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable4.adoc @@ -7,40 +7,24 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when_not: yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "rougail.condition" hasn't the value "yes". +**Désactivé**: when the variable "rougail.condition" hasn't the value "yes". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: yes - variable: example ----- diff --git a/tests/docs/base/04_5disabled_calculation_variable4.md b/tests/docs/base/04_5disabled_calculation_variable4.md index ef271d1..3d34649 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.md +++ b/tests/docs/base/04_5disabled_calculation_variable4.md @@ -11,30 +11,14 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when_not: yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" hasn't the value "yes". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "rougail.condition" hasn't the value "yes". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: yes - variable: example -``` diff --git a/tests/docs/base/04_5hidden_calculation.adoc b/tests/docs/base/04_5hidden_calculation.adoc index e96db03..d52c290 100644 --- a/tests/docs/base/04_5hidden_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation.adoc @@ -8,7 +8,6 @@ var1: description: a first variable default: no hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -18,44 +17,34 @@ var2: description: a second variable default: no hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="119a,119a",options="header"] +[cols="120a,120a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The condition. + -**Default**: no +**Défaut**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A first variable. + -**Default**: no + -**Hidden**: if condition is yes. +**Défaut**: no + +**Caché**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A second variable. + -**Default**: no + -**Hidden**: if condition is yes. +**Défaut**: no + +**Caché**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var1: no - var2: no ----- diff --git a/tests/docs/base/04_5hidden_calculation.md b/tests/docs/base/04_5hidden_calculation.md index b42fb10..63fa69d 100644 --- a/tests/docs/base/04_5hidden_calculation.md +++ b/tests/docs/base/04_5hidden_calculation.md @@ -12,7 +12,6 @@ var1: description: a first variable default: no hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -22,28 +21,18 @@ var2: description: a second variable default: no hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: no
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: no
**Hidden**: if condition is yes. | +| Variable                                                                                                               | Description                                                                                                            | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The condition.
**Défaut**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A first variable.
**Défaut**: no
**Caché**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A second variable.
**Défaut**: no
**Caché**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var1: no - var2: no -``` diff --git a/tests/docs/base/04_5hidden_calculation2.adoc b/tests/docs/base/04_5hidden_calculation2.adoc index 382b1b3..e81ae0a 100644 --- a/tests/docs/base/04_5hidden_calculation2.adoc +++ b/tests/docs/base/04_5hidden_calculation2.adoc @@ -7,63 +7,50 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if _.condition != "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: the value of condition var2: description: a second variable hidden: - type: jinja jinja: | {% if rougail.condition != "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: the value of condition ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="119a,119a",options="header"] +[cols="120a,120a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A first variable. + -**Default**: the value of condition. + -**Hidden**: if condition is yes. +**Défaut**: the value of condition. + +**Caché**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A second variable. + -**Default**: the value of condition. + -**Hidden**: if condition is yes. +**Défaut**: the value of condition. + +**Caché**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var1: no - var2: no ----- diff --git a/tests/docs/base/04_5hidden_calculation2.md b/tests/docs/base/04_5hidden_calculation2.md index cfdf3eb..48bfc20 100644 --- a/tests/docs/base/04_5hidden_calculation2.md +++ b/tests/docs/base/04_5hidden_calculation2.md @@ -11,47 +11,34 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if _.condition != "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: the value of condition var2: description: a second variable hidden: - type: jinja jinja: | {% if rougail.condition != "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: the value of condition ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | +| Variable                                                                                                               | Description                                                                                                            | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A first variable.
**Défaut**: the value of condition.
**Caché**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A second variable.
**Défaut**: the value of condition.
**Caché**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var1: no - var2: no -``` diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc index 9718eba..611ca92 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc @@ -7,63 +7,50 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: returns the condition value var2: description: a second variable hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: returns the condition value ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="119a,119a",options="header"] +[cols="120a,120a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A first variable. + -**Default**: returns the condition value. + -**Hidden**: if condition is yes. +**Défaut**: returns the condition value. + +**Caché**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`caché`_ | A second variable. + -**Default**: returns the condition value. + -**Hidden**: if condition is yes. +**Défaut**: returns the condition value. + +**Caché**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var1: no - var2: no ----- diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.md b/tests/docs/base/04_5hidden_calculation_default_calculation.md index 6f0f4ca..c6dfe8c 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.md +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.md @@ -11,47 +11,34 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ _.condition }} description: returns the condition value var2: description: a second variable hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes default: - type: jinja jinja: | {{ rougail.condition }} description: returns the condition value ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | +| Variable                                                                                                               | Description                                                                                                            | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A first variable.
**Défaut**: returns the condition value.
**Caché**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`caché`_ | A second variable.
**Défaut**: returns the condition value.
**Caché**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var1: no - var2: no -``` diff --git a/tests/docs/base/04_5validators.adoc b/tests/docs/base/04_5validators.adoc index 0a7ea78..e58cdff 100644 --- a/tests/docs/base/04_5validators.adoc +++ b/tests/docs/base/04_5validators.adoc @@ -7,37 +7,22 @@ int: description: A number type: number validators: - - type: jinja - jinja: | + - jinja: | {% if _.int > 100 %} value is too high {% endif %} description: the max value is 100 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `obligatoire` | A number. + -**Validator**: the max value is 100. +**Validator**: the max value is 100. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - int: 42 ----- diff --git a/tests/docs/base/04_5validators.md b/tests/docs/base/04_5validators.md index 035ebf7..4d15f0c 100644 --- a/tests/docs/base/04_5validators.md +++ b/tests/docs/base/04_5validators.md @@ -11,31 +11,16 @@ int: description: A number type: number validators: - - type: jinja - jinja: | + - jinja: | {% if _.int > 100 %} value is too high {% endif %} description: the max value is 100 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A number.
**Validator**: the max value is 100. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - int: 42 -``` diff --git a/tests/docs/base/04_5validators_differ.adoc b/tests/docs/base/04_5validators_differ.adoc index 0e10524..e76da69 100644 --- a/tests/docs/base/04_5validators_differ.adoc +++ b/tests/docs/base/04_5validators_differ.adoc @@ -5,41 +5,35 @@ version: '1.1' var1: description: a first variable + test: + - another_value type: string default: oui validators: - - type: jinja - jinja: | + - jinja: | {% if _.var1 == _.var2 %} var1 must be different than var2 {% endif %} description: var1 must be different than var2 var2: no # A second variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + **Validator**: var1 must be different than var2. + -**Default**: oui +**Défaut**: oui + +**Exemple**: another_value | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: oui - var2: no ----- diff --git a/tests/docs/base/04_5validators_differ.md b/tests/docs/base/04_5validators_differ.md index 8f4d30e..79dcb37 100644 --- a/tests/docs/base/04_5validators_differ.md +++ b/tests/docs/base/04_5validators_differ.md @@ -9,30 +9,23 @@ include_toc: true version: '1.1' var1: description: a first variable + test: + - another_value type: string default: oui validators: - - type: jinja - jinja: | + - jinja: | {% if _.var1 == _.var2 %} var1 must be different than var2 {% endif %} description: var1 must be different than var2 var2: no # A second variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Validator**: var1 must be different than var2.
**Défaut**: oui
**Exemple**: another_value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: oui - var2: no -``` diff --git a/tests/docs/base/04_5validators_multi.adoc b/tests/docs/base/04_5validators_multi.adoc new file mode 100644 index 0000000..821cd82 --- /dev/null +++ b/tests/docs/base/04_5validators_multi.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 10. + +**Défaut**: + +* no +* yes +|==== + + diff --git a/tests/docs/base/04_5validators_multi.md b/tests/docs/base/04_5validators_multi.md new file mode 100644 index 0000000..3ac14ab --- /dev/null +++ b/tests/docs/base/04_5validators_multi.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Défaut**:
- no
- yes | + + diff --git a/tests/docs/base/04_5validators_multi2.adoc b/tests/docs/base/04_5validators_multi2.adoc new file mode 100644 index 0000000..7cb6a38 --- /dev/null +++ b/tests/docs/base/04_5validators_multi2.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 3. + +**Défaut**: + +* no +* yes + +**Exemples**: + +* val1 +* val2 +|==== + + diff --git a/tests/docs/base/04_5validators_multi2.md b/tests/docs/base/04_5validators_multi2.md new file mode 100644 index 0000000..d4b8f74 --- /dev/null +++ b/tests/docs/base/04_5validators_multi2.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Défaut**:
- no
- yes
**Exemples**:
- val1
- val2 | + + diff --git a/tests/docs/base/04_7validators_variable_optional.adoc b/tests/docs/base/04_7validators_variable_optional.adoc index 27d7177..03d0dde 100644 --- a/tests/docs/base/04_7validators_variable_optional.adoc +++ b/tests/docs/base/04_7validators_variable_optional.adoc @@ -7,70 +7,53 @@ general: # a family int: description: a first number type: number + test: + - 5 validators: - - type: jinja - jinja: | + - jinja: | {% if _.int == int2 %} int and int2 must be different {% endif %} params: int2: - type: variable variable: _.int2 optional: true description: int and int2 must be different - - type: jinja - jinja: | - {% if _.int == int3 %} + - jinja: | + {% if int3 is defined and _.int == int3 %} int and int3 must be different {% endif %} params: int3: - type: variable variable: _.int3 optional: true description: int and int3 must be different int2: 1 # a second number ---- -== Variables for "rougail" +== Variables pour "rougail" === a family `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.general.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `obligatoire` | A first number. + **Validators**: * int and int2 must be different. -* int and int3 must be different. +* int and int3 must be different. + +**Exemple**: 5 | **rougail.general.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A second number. + -**Default**: 1 +**Défaut**: 1 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - general: - int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - general: - int: 42 - int2: 1 ----- diff --git a/tests/docs/base/04_7validators_variable_optional.md b/tests/docs/base/04_7validators_variable_optional.md index a89e2ab..92568db 100644 --- a/tests/docs/base/04_7validators_variable_optional.md +++ b/tests/docs/base/04_7validators_variable_optional.md @@ -11,57 +11,38 @@ general: # a family int: description: a first number type: number + test: + - 5 validators: - - type: jinja - jinja: | + - jinja: | {% if _.int == int2 %} int and int2 must be different {% endif %} params: int2: - type: variable variable: _.int2 optional: true description: int and int2 must be different - - type: jinja - jinja: | - {% if _.int == int3 %} + - jinja: | + {% if int3 is defined and _.int == int3 %} int and int3 must be different {% endif %} params: int3: - type: variable variable: _.int3 optional: true description: int and int3 must be different int2: 1 # a second number ``` -# Variables for "rougail" +# Variables pour "rougail" ## a family `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different. | -| **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different.
**Exemple**: 5 | +| **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second number.
**Défaut**: 1 | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - general: - int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - general: - int: 42 - int2: 1 -``` diff --git a/tests/docs/base/05_0multi_not_uniq.adoc b/tests/docs/base/05_0multi_not_uniq.adoc index 9626f7a..9fde292 100644 --- a/tests/docs/base/05_0multi_not_uniq.adoc +++ b/tests/docs/base/05_0multi_not_uniq.adoc @@ -9,26 +9,18 @@ var1: default: - non ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - non ----- diff --git a/tests/docs/base/05_0multi_not_uniq.md b/tests/docs/base/05_0multi_not_uniq.md index 508f268..71c74ad 100644 --- a/tests/docs/base/05_0multi_not_uniq.md +++ b/tests/docs/base/05_0multi_not_uniq.md @@ -13,18 +13,10 @@ var1: default: - non ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - non -``` diff --git a/tests/docs/base/05_0multi_uniq.adoc b/tests/docs/base/05_0multi_uniq.adoc index 0d0a378..ce9ca90 100644 --- a/tests/docs/base/05_0multi_uniq.adoc +++ b/tests/docs/base/05_0multi_uniq.adoc @@ -9,26 +9,18 @@ variable: default: - non ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - non ----- diff --git a/tests/docs/base/05_0multi_uniq.md b/tests/docs/base/05_0multi_uniq.md index 621d288..43fb422 100644 --- a/tests/docs/base/05_0multi_uniq.md +++ b/tests/docs/base/05_0multi_uniq.md @@ -13,18 +13,10 @@ variable: default: - non ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - non -``` diff --git a/tests/docs/base/16_0redefine_description.adoc b/tests/docs/base/16_0redefine_description.adoc index 1fca07d..8b4344c 100644 --- a/tests/docs/base/16_0redefine_description.adoc +++ b/tests/docs/base/16_0redefine_description.adoc @@ -15,29 +15,15 @@ var: description: Redefined redefine: true ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Redefined. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Redefined. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: example ----- diff --git a/tests/docs/base/16_0redefine_description.md b/tests/docs/base/16_0redefine_description.md index 3be0f1d..7ade0b8 100644 --- a/tests/docs/base/16_0redefine_description.md +++ b/tests/docs/base/16_0redefine_description.md @@ -19,24 +19,10 @@ var: description: Redefined redefine: true ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Redefined. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: example -``` diff --git a/tests/docs/base/16_2family_redefine_calculation.adoc b/tests/docs/base/16_2family_redefine_calculation.adoc index a8ff75f..ac92de2 100644 --- a/tests/docs/base/16_2family_redefine_calculation.adoc +++ b/tests/docs/base/16_2family_redefine_calculation.adoc @@ -6,7 +6,6 @@ version: '1.0' family: redefine: true disabled: - type: jinja jinja: | true ---- @@ -18,37 +17,21 @@ version: '1.0' family: var1: ---- -== Variables for "rougail" +== Variables pour "rougail" === rougail.family -`basic` _`disabled`_ +`basic` _`désactivé`_ -**Disabled**: issu d'un calcul. +**Désactivé**: depends on a calculation. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Var1. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - var1: example ----- diff --git a/tests/docs/base/16_2family_redefine_calculation.md b/tests/docs/base/16_2family_redefine_calculation.md index 466e787..4a03fb6 100644 --- a/tests/docs/base/16_2family_redefine_calculation.md +++ b/tests/docs/base/16_2family_redefine_calculation.md @@ -10,7 +10,6 @@ version: '1.0' family: redefine: true disabled: - type: jinja jinja: | true ``` @@ -22,32 +21,16 @@ version: '1.0' family: var1: ``` -# Variables for "rougail" +# Variables pour "rougail" ## rougail.family -`basic` _`disabled`_ +`basic` _`désactivé`_ -**Disabled**: issu d'un calcul. +**Désactivé**: depends on a calculation. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Var1. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - var1: example -``` diff --git a/tests/docs/base/16_5exists_nonexists.adoc b/tests/docs/base/16_5exists_nonexists.adoc index fc080ab..68795e1 100644 --- a/tests/docs/base/16_5exists_nonexists.adoc +++ b/tests/docs/base/16_5exists_nonexists.adoc @@ -15,29 +15,21 @@ var2: version: '1.1' var1: no # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A new variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: yes ----- diff --git a/tests/docs/base/16_5exists_nonexists.md b/tests/docs/base/16_5exists_nonexists.md index c556883..427236c 100644 --- a/tests/docs/base/16_5exists_nonexists.md +++ b/tests/docs/base/16_5exists_nonexists.md @@ -19,19 +19,11 @@ var2: version: '1.1' var1: no # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A new variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: yes -``` diff --git a/tests/docs/base/16_5exists_redefine.adoc b/tests/docs/base/16_5exists_redefine.adoc index 04d36a1..ffd4c3d 100644 --- a/tests/docs/base/16_5exists_redefine.adoc +++ b/tests/docs/base/16_5exists_redefine.adoc @@ -22,4 +22,5 @@ var1: description: a first variable hidden: true default: no + mandatory: false ---- diff --git a/tests/docs/base/16_5exists_redefine.md b/tests/docs/base/16_5exists_redefine.md index 40f84ee..695da7d 100644 --- a/tests/docs/base/16_5exists_redefine.md +++ b/tests/docs/base/16_5exists_redefine.md @@ -26,4 +26,5 @@ var1: description: a first variable hidden: true default: no + mandatory: false ``` diff --git a/tests/docs/base/16_5redefine_calculation.adoc b/tests/docs/base/16_5redefine_calculation.adoc index 214230c..2f0a660 100644 --- a/tests/docs/base/16_5redefine_calculation.adoc +++ b/tests/docs/base/16_5redefine_calculation.adoc @@ -6,7 +6,6 @@ version: '1.1' variable: redefine: true default: - type: jinja jinja: yes description: returns yes ---- @@ -18,27 +17,19 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: returns no ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: returns yes. +**Défaut**: returns yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: yes ----- diff --git a/tests/docs/base/16_5redefine_calculation.md b/tests/docs/base/16_5redefine_calculation.md index 4c6f78a..995d26e 100644 --- a/tests/docs/base/16_5redefine_calculation.md +++ b/tests/docs/base/16_5redefine_calculation.md @@ -10,7 +10,6 @@ version: '1.1' variable: redefine: true default: - type: jinja jinja: yes description: returns yes ``` @@ -22,21 +21,13 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: returns no ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: returns yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: yes -``` diff --git a/tests/docs/base/16_5redefine_choice.adoc b/tests/docs/base/16_5redefine_choice.adoc index 4f80ab8..d9d146e 100644 --- a/tests/docs/base/16_5redefine_choice.adoc +++ b/tests/docs/base/16_5redefine_choice.adoc @@ -21,33 +21,19 @@ variable: - a - b ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A variable. + -**Choices**: +**Choix**: * a -* b +* b |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: a_choice ----- diff --git a/tests/docs/base/16_5redefine_choice.md b/tests/docs/base/16_5redefine_choice.md index 7a03911..a6a1142 100644 --- a/tests/docs/base/16_5redefine_choice.md +++ b/tests/docs/base/16_5redefine_choice.md @@ -25,24 +25,10 @@ variable: - a - b ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable.
**Choix**:
- a
- b | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: a_choice -``` diff --git a/tests/docs/base/16_5redefine_default.adoc b/tests/docs/base/16_5redefine_default.adoc index eda78fc..f7244d9 100644 --- a/tests/docs/base/16_5redefine_default.adoc +++ b/tests/docs/base/16_5redefine_default.adoc @@ -16,23 +16,16 @@ variable: redefine: true default: yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: yes ----- diff --git a/tests/docs/base/16_5redefine_default.md b/tests/docs/base/16_5redefine_default.md index 8b51d53..26d0b0e 100644 --- a/tests/docs/base/16_5redefine_default.md +++ b/tests/docs/base/16_5redefine_default.md @@ -20,17 +20,10 @@ variable: redefine: true default: yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: yes -``` diff --git a/tests/docs/base/16_5redefine_default_calculation.adoc b/tests/docs/base/16_5redefine_default_calculation.adoc index 7a5439f..5e5e696 100644 --- a/tests/docs/base/16_5redefine_default_calculation.adoc +++ b/tests/docs/base/16_5redefine_default_calculation.adoc @@ -15,32 +15,17 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: example ----- diff --git a/tests/docs/base/16_5redefine_default_calculation.md b/tests/docs/base/16_5redefine_default_calculation.md index cc541e3..f60e3b1 100644 --- a/tests/docs/base/16_5redefine_default_calculation.md +++ b/tests/docs/base/16_5redefine_default_calculation.md @@ -19,27 +19,12 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: example -``` diff --git a/tests/docs/base/16_5redefine_family.adoc b/tests/docs/base/16_5redefine_family.adoc index 46dc599..9b94836 100644 --- a/tests/docs/base/16_5redefine_family.adoc +++ b/tests/docs/base/16_5redefine_family.adoc @@ -15,35 +15,19 @@ version: '1.1' family: # a family variable: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" === new description `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - variable: example ----- diff --git a/tests/docs/base/16_5redefine_family.md b/tests/docs/base/16_5redefine_family.md index f15399b..fef6caa 100644 --- a/tests/docs/base/16_5redefine_family.md +++ b/tests/docs/base/16_5redefine_family.md @@ -19,30 +19,14 @@ version: '1.1' family: # a family variable: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" ## new description `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - variable: example -``` diff --git a/tests/docs/base/16_5redefine_help.adoc b/tests/docs/base/16_5redefine_help.adoc index a6f1800..f506dde 100644 --- a/tests/docs/base/16_5redefine_help.adoc +++ b/tests/docs/base/16_5redefine_help.adoc @@ -22,7 +22,7 @@ family: description: redefine help help: redefine help ---- -== Variables for "rougail" +== Variables pour "rougail" === a family @@ -31,30 +31,14 @@ family: Redefine help family ok. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | Redefine help. + -Redefine help ok. +Redefine help ok. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - variable: example ----- diff --git a/tests/docs/base/16_5redefine_help.md b/tests/docs/base/16_5redefine_help.md index c5b2ea1..ef335f1 100644 --- a/tests/docs/base/16_5redefine_help.md +++ b/tests/docs/base/16_5redefine_help.md @@ -26,7 +26,7 @@ family: description: redefine help help: redefine help ``` -# Variables for "rougail" +# Variables pour "rougail" ## a family @@ -35,24 +35,8 @@ family: Redefine help family ok. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefine help.
Redefine help ok. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Redefine help.
Redefine help ok. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - variable: example -``` diff --git a/tests/docs/base/16_5redefine_hidden.adoc b/tests/docs/base/16_5redefine_hidden.adoc index e484541..e6861a6 100644 --- a/tests/docs/base/16_5redefine_hidden.adoc +++ b/tests/docs/base/16_5redefine_hidden.adoc @@ -13,4 +13,5 @@ version: '1.1' variable: redefine: true hidden: true + mandatory: false ---- diff --git a/tests/docs/base/16_5redefine_hidden.md b/tests/docs/base/16_5redefine_hidden.md index d0b8ac8..6233386 100644 --- a/tests/docs/base/16_5redefine_hidden.md +++ b/tests/docs/base/16_5redefine_hidden.md @@ -17,4 +17,5 @@ version: '1.1' variable: redefine: true hidden: true + mandatory: false ``` diff --git a/tests/docs/base/16_5redefine_multi.adoc b/tests/docs/base/16_5redefine_multi.adoc index 3fd8033..3d48500 100644 --- a/tests/docs/base/16_5redefine_multi.adoc +++ b/tests/docs/base/16_5redefine_multi.adoc @@ -18,26 +18,18 @@ variable: default: - non ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: - - non ----- diff --git a/tests/docs/base/16_5redefine_multi.md b/tests/docs/base/16_5redefine_multi.md index 9f0c9c6..07e4aad 100644 --- a/tests/docs/base/16_5redefine_multi.md +++ b/tests/docs/base/16_5redefine_multi.md @@ -22,18 +22,10 @@ variable: default: - non ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: - - non -``` diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc index 9bafb69..22b2a31 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc @@ -16,7 +16,6 @@ condition: no # a condition variable: description: a variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} true @@ -24,35 +23,20 @@ variable: false {% endif %} ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - variable: example ----- diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.md b/tests/docs/base/16_5redefine_remove_disable_calculation.md index b3a83ad..8c7f394 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.md +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.md @@ -20,7 +20,6 @@ condition: no # a condition variable: description: a variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} true @@ -28,26 +27,11 @@ variable: false {% endif %} ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - variable: example -``` diff --git a/tests/docs/base/16_5test_redefine.adoc b/tests/docs/base/16_5test_redefine.adoc index af9e5f6..7cee74d 100644 --- a/tests/docs/base/16_5test_redefine.adoc +++ b/tests/docs/base/16_5test_redefine.adoc @@ -31,45 +31,27 @@ var3: redefine: true test: ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no + -**Example**: test1 +**Défaut**: no + +**Exemple**: test1 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: non + -**Example**: test1 +**Défaut**: non + +**Exemple**: test1 | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A third variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var1: test1 - var2: test1 - var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: test1 - var2: test1 - var3: example ----- diff --git a/tests/docs/base/16_5test_redefine.md b/tests/docs/base/16_5test_redefine.md index 81a171d..7d26d9c 100644 --- a/tests/docs/base/16_5test_redefine.md +++ b/tests/docs/base/16_5test_redefine.md @@ -35,30 +35,12 @@ var3: redefine: true test: ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no
**Exemple**: test1 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: non
**Exemple**: test1 | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A third variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var1: test1 - var2: test1 - var3: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: test1 - var2: test1 - var3: example -``` diff --git a/tests/docs/base/16_6choice_redefine.adoc b/tests/docs/base/16_6choice_redefine.adoc index d7d24ce..25e5638 100644 --- a/tests/docs/base/16_6choice_redefine.adoc +++ b/tests/docs/base/16_6choice_redefine.adoc @@ -23,26 +23,19 @@ var: - b - c ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A choice. + -**Choices**: +**Choix**: * a -* c ← (default) +* c ← (defaut) |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: c ----- diff --git a/tests/docs/base/16_6choice_redefine.md b/tests/docs/base/16_6choice_redefine.md index 5c154f7..a96a012 100644 --- a/tests/docs/base/16_6choice_redefine.md +++ b/tests/docs/base/16_6choice_redefine.md @@ -27,17 +27,10 @@ var: - b - c ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A choice.
**Choix**:
- a
- c ← (defaut) | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: c -``` diff --git a/tests/docs/base/16exists_exists.adoc b/tests/docs/base/16exists_exists.adoc index e11c21f..4100a49 100644 --- a/tests/docs/base/16exists_exists.adoc +++ b/tests/docs/base/16exists_exists.adoc @@ -15,29 +15,15 @@ version: '1.1' var: description: Description ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Description. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Description. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: example ----- diff --git a/tests/docs/base/16exists_exists.md b/tests/docs/base/16exists_exists.md index 419b752..23b06a8 100644 --- a/tests/docs/base/16exists_exists.md +++ b/tests/docs/base/16exists_exists.md @@ -19,24 +19,10 @@ version: '1.1' var: description: Description ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Description. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: example -``` diff --git a/tests/docs/base/17_5redefine_leadership.adoc b/tests/docs/base/17_5redefine_leadership.adoc index 3e7fb3c..8b41cc5 100644 --- a/tests/docs/base/17_5redefine_leadership.adoc +++ b/tests/docs/base/17_5redefine_leadership.adoc @@ -14,6 +14,11 @@ leader: version: '1.1' leader: # a leadership type: leadership - leader: [] # a leader - follower: # a follower + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/base/17_5redefine_leadership.md b/tests/docs/base/17_5redefine_leadership.md index 6890c87..58d32e4 100644 --- a/tests/docs/base/17_5redefine_leadership.md +++ b/tests/docs/base/17_5redefine_leadership.md @@ -18,6 +18,11 @@ leader: version: '1.1' leader: # a leadership type: leadership - leader: [] # a leader - follower: # a follower + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/base/20_0family_append.adoc b/tests/docs/base/20_0family_append.adoc index 5a5ece4..de6df06 100644 --- a/tests/docs/base/20_0family_append.adoc +++ b/tests/docs/base/20_0family_append.adoc @@ -17,41 +17,23 @@ family: var1: description: The first variable ---- -== Variables for "rougail" +== Variables pour "rougail" === A family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The first variable. | **rougail.family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The second variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - var1: example - var2: example ----- diff --git a/tests/docs/base/20_0family_append.md b/tests/docs/base/20_0family_append.md index f926f23..8c54ef0 100644 --- a/tests/docs/base/20_0family_append.md +++ b/tests/docs/base/20_0family_append.md @@ -21,33 +21,15 @@ family: var1: description: The first variable ``` -# Variables for "rougail" +# Variables pour "rougail" ## A family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - var1: example - var2: example -``` diff --git a/tests/docs/base/20_0family_underscore.adoc b/tests/docs/base/20_0family_underscore.adoc index d7798d8..e18f2fd 100644 --- a/tests/docs/base/20_0family_underscore.adoc +++ b/tests/docs/base/20_0family_underscore.adoc @@ -7,20 +7,23 @@ my_family: _type: family _description: This is a great family _help: This is a great family - _mode: basic + _mode: standard _hidden: true _disabled: true type: description: a type family type: family my_variable: + mandatory: false description: description: This is a other great family my_variable: + mandatory: false help: description: a help family help: This is a other great family my_variable: + mandatory: false mode: description: a mode family mode: advanced @@ -30,8 +33,10 @@ my_family: description: an hidden family hidden: true my_variable: + mandatory: false disabled: description: an disabled family disabled: true my_variable: + mandatory: false ---- diff --git a/tests/docs/base/20_0family_underscore.md b/tests/docs/base/20_0family_underscore.md index c580bd7..f75a46e 100644 --- a/tests/docs/base/20_0family_underscore.md +++ b/tests/docs/base/20_0family_underscore.md @@ -11,20 +11,23 @@ my_family: _type: family _description: This is a great family _help: This is a great family - _mode: basic + _mode: standard _hidden: true _disabled: true type: description: a type family type: family my_variable: + mandatory: false description: description: This is a other great family my_variable: + mandatory: false help: description: a help family help: This is a other great family my_variable: + mandatory: false mode: description: a mode family mode: advanced @@ -34,8 +37,10 @@ my_family: description: an hidden family hidden: true my_variable: + mandatory: false disabled: description: an disabled family disabled: true my_variable: + mandatory: false ``` diff --git a/tests/docs/base/20_0multi_family.adoc b/tests/docs/base/20_0multi_family.adoc index 6b271e2..2b563c0 100644 --- a/tests/docs/base/20_0multi_family.adoc +++ b/tests/docs/base/20_0multi_family.adoc @@ -9,7 +9,7 @@ family: # a family description: a variable mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" === a family @@ -29,12 +29,3 @@ A variable. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - subfamily: - variable: example ----- diff --git a/tests/docs/base/20_0multi_family.md b/tests/docs/base/20_0multi_family.md index 00b1e5d..8669064 100644 --- a/tests/docs/base/20_0multi_family.md +++ b/tests/docs/base/20_0multi_family.md @@ -13,7 +13,7 @@ family: # a family description: a variable mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" ## a family @@ -28,12 +28,3 @@ family: # a family | **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - subfamily: - variable: example -``` diff --git a/tests/docs/base/20_0multi_family_basic.adoc b/tests/docs/base/20_0multi_family_basic.adoc index d3facb0..85e3d0f 100644 --- a/tests/docs/base/20_0multi_family_basic.adoc +++ b/tests/docs/base/20_0multi_family_basic.adoc @@ -7,7 +7,7 @@ family: # a family subfamily: # a sub family variable: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" === a family @@ -17,31 +17,13 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - subfamily: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - subfamily: - variable: example ----- diff --git a/tests/docs/base/20_0multi_family_basic.md b/tests/docs/base/20_0multi_family_basic.md index 0f96847..f985bb5 100644 --- a/tests/docs/base/20_0multi_family_basic.md +++ b/tests/docs/base/20_0multi_family_basic.md @@ -11,7 +11,7 @@ family: # a family subfamily: # a sub family variable: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" ## a family @@ -21,26 +21,8 @@ family: # a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - subfamily: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - subfamily: - variable: example -``` diff --git a/tests/docs/base/20_0multi_family_order.adoc b/tests/docs/base/20_0multi_family_order.adoc index 407aa71..a344dc3 100644 --- a/tests/docs/base/20_0multi_family_order.adoc +++ b/tests/docs/base/20_0multi_family_order.adoc @@ -10,74 +10,50 @@ family: # a family variable: # a variable variable2: # a second variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== === a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. |==== ==== a sub family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A second variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - variable: example - family: - variable1: example - subfamily: - variable: example - variable2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - variable: example - family: - variable1: example - subfamily: - variable: example - variable2: example ----- diff --git a/tests/docs/base/20_0multi_family_order.md b/tests/docs/base/20_0multi_family_order.md index 834d2f5..1851639 100644 --- a/tests/docs/base/20_0multi_family_order.md +++ b/tests/docs/base/20_0multi_family_order.md @@ -14,54 +14,30 @@ family: # a family variable: # a variable variable2: # a second variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | ## a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | ### a sub family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - variable: example - family: - variable1: example - subfamily: - variable: example - variable2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - variable: example - family: - variable1: example - subfamily: - variable: example - variable2: example -``` diff --git a/tests/docs/base/20_0validators_differ_redefine.adoc b/tests/docs/base/20_0validators_differ_redefine.adoc index f93c0e8..c5619a6 100644 --- a/tests/docs/base/20_0validators_differ_redefine.adoc +++ b/tests/docs/base/20_0validators_differ_redefine.adoc @@ -6,8 +6,7 @@ version: '1.1' var3: redefine: true validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var2 %} var3 must be different than var2 {% endif %} @@ -23,44 +22,37 @@ var2: no # a second variable var3: description: a third variable default: yes + test: + - yes validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var1 %} var3 must be different than var1 {% endif %} description: var3 must be different than var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A third variable. + **Validator**: var3 must be different than var2. + -**Default**: yes +**Défaut**: yes + +**Exemple**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: no - var2: no - var3: yes ----- diff --git a/tests/docs/base/20_0validators_differ_redefine.md b/tests/docs/base/20_0validators_differ_redefine.md index 613f860..c9909ad 100644 --- a/tests/docs/base/20_0validators_differ_redefine.md +++ b/tests/docs/base/20_0validators_differ_redefine.md @@ -10,8 +10,7 @@ version: '1.1' var3: redefine: true validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var2 %} var3 must be different than var2 {% endif %} @@ -27,29 +26,21 @@ var2: no # a second variable var3: description: a third variable default: yes + test: + - yes validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var1 %} var3 must be different than var1 {% endif %} description: var3 must be different than var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Validator**: var3 must be different than var2.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Validator**: var3 must be different than var2.
**Défaut**: yes
**Exemple**: yes | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: no - var2: no - var3: yes -``` diff --git a/tests/docs/base/20_9default_information_parent.adoc b/tests/docs/base/20_9default_information_parent.adoc index b828150..7440cac 100644 --- a/tests/docs/base/20_9default_information_parent.adoc +++ b/tests/docs/base/20_9default_information_parent.adoc @@ -12,42 +12,24 @@ family: information: test_information variable: __.family ---- -== Variables for "rougail" +== Variables pour "rougail" === rougail.family `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **rougail.family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: value of the information. +**Défaut**: la valeur de information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - var1: example - var2: example ----- diff --git a/tests/docs/base/20_9default_information_parent.md b/tests/docs/base/20_9default_information_parent.md index c78d58a..79911af 100644 --- a/tests/docs/base/20_9default_information_parent.md +++ b/tests/docs/base/20_9default_information_parent.md @@ -16,33 +16,15 @@ family: information: test_information variable: __.family ``` -# Variables for "rougail" +# Variables pour "rougail" ## rougail.family `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **rougail.family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: la valeur de information. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - var1: example - var2: example -``` diff --git a/tests/docs/base/24_0family_hidden_condition.adoc b/tests/docs/base/24_0family_hidden_condition.adoc index 159e2aa..9f2f8de 100644 --- a/tests/docs/base/24_0family_hidden_condition.adoc +++ b/tests/docs/base/24_0family_hidden_condition.adoc @@ -7,7 +7,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes @@ -15,48 +14,31 @@ family: description: if condition is yes var1: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The variable use has condition. + -**Default**: no +**Défaut**: no |==== === possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - family: - var1: example ----- diff --git a/tests/docs/base/24_0family_hidden_condition.md b/tests/docs/base/24_0family_hidden_condition.md index 6768768..b809a6f 100644 --- a/tests/docs/base/24_0family_hidden_condition.md +++ b/tests/docs/base/24_0family_hidden_condition.md @@ -11,7 +11,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes @@ -19,37 +18,20 @@ family: description: if condition is yes var1: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: no | ## possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - family: - var1: example -``` diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.adoc b/tests/docs/base/24_0family_hidden_condition_boolean.adoc index 74a8aeb..d92cfcc 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.adoc +++ b/tests/docs/base/24_0family_hidden_condition_boolean.adoc @@ -7,56 +7,40 @@ condition: false # a conditional variable family: description: a family hidden: - type: jinja jinja: | {% if not rougail.condition %} condition is false {% endif %} description: if not condition - variable: # a variable + variable: + description: a variable + mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A conditional variable. + -**Default**: False +**Défaut**: False |==== === a family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if not condition. +**Caché**: if not condition. -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: false - family: - variable: example ----- diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.md b/tests/docs/base/24_0family_hidden_condition_boolean.md index 72dc7e1..14c5fd8 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.md +++ b/tests/docs/base/24_0family_hidden_condition_boolean.md @@ -11,45 +11,29 @@ condition: false # a conditional variable family: description: a family hidden: - type: jinja jinja: | {% if not rougail.condition %} condition is false {% endif %} description: if not condition - variable: # a variable + variable: + description: a variable + mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: False | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A conditional variable.
**Défaut**: False | ## a family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if not condition. +**Caché**: if not condition. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: false - family: - variable: example -``` diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc index 039375d..ce4ae9d 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc @@ -7,7 +7,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -16,54 +15,35 @@ family: subfamily: var1: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The variable use has condition. + -**Default**: no +**Défaut**: no |==== === possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ==== rougail.family.subfamily `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - subfamily: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - family: - subfamily: - var1: example ----- diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.md b/tests/docs/base/24_0family_hidden_condition_sub_family.md index 091de6e..780e5df 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.md +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.md @@ -11,7 +11,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -20,43 +19,24 @@ family: subfamily: var1: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: no | ## possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ### rougail.family.subfamily `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - subfamily: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - family: - subfamily: - var1: example -``` diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc index e309f7f..838e747 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc @@ -7,59 +7,41 @@ condition: true # the variable use has condition family: description: possibly hidden family hidden: - type: variable variable: _.condition subfamily: # a subfamily - var1: # a variable + var1: + description: a variable + mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The variable use has condition. + -**Default**: True +**Défaut**: True |==== === possibly hidden family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: when the variable "rougail.condition" has the value "True". +**Caché**: when the variable "rougail.condition" has the value "True". ==== a subfamily -`basic` +`standard` -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - subfamily: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: true - family: - subfamily: - var1: example ----- diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md index 6ec1c23..f5b16fc 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md @@ -11,48 +11,30 @@ condition: true # the variable use has condition family: description: possibly hidden family hidden: - type: variable variable: _.condition subfamily: # a subfamily - var1: # a variable + var1: + description: a variable + mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: True | ## possibly hidden family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: when the variable "rougail.condition" has the value "True". +**Caché**: when the variable "rougail.condition" has the value "True". ### a subfamily -`basic` +`standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - subfamily: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: true - family: - subfamily: - var1: example -``` diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc index f4301fa..feffb37 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc @@ -8,7 +8,6 @@ condition2: false # a second conditional variable family: description: a family hidden: - type: jinja jinja: | {% if not rougail.condition1 %} condition1 is false @@ -17,62 +16,44 @@ family: variable: description: a variable hidden: - type: jinja jinja: | {% if rougail.condition2 %} condition2 is true {% endif %} description: if condition2 is false + mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="116a,116a",options="header"] +[cols="106a,106a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A first conditional variable. + -**Default**: False +**Défaut**: False | **rougail.condition2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A second conditional variable. + -**Default**: False +**Défaut**: False |==== === a family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if condition1 is false. +**Caché**: if condition1 is false. -[cols="116a,116a",options="header"] +[cols="106a,106a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`caché`_ | A variable. + -**Hidden**: if condition2 is false. +**Caché**: if condition2 is false. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition1: false - condition2: false - family: - variable: example ----- diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.md b/tests/docs/base/24_0family_hidden_condition_with_variable.md index cafc4b4..3181e27 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.md +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.md @@ -12,7 +12,6 @@ condition2: false # a second conditional variable family: description: a family hidden: - type: jinja jinja: | {% if not rougail.condition1 %} condition1 is false @@ -21,46 +20,28 @@ family: variable: description: a variable hidden: - type: jinja jinja: | {% if rougail.condition2 %} condition2 is true {% endif %} description: if condition2 is false + mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first conditional variable.
**Default**: False | -| **rougail.condition2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second conditional variable.
**Default**: False | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first conditional variable.
**Défaut**: False | +| **rougail.condition2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second conditional variable.
**Défaut**: False | ## a family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if condition1 is false. +**Caché**: if condition1 is false. -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A variable.
**Hidden**: if condition2 is false. | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`caché`_ | A variable.
**Caché**: if condition2 is false. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition1: false - condition2: false - family: - variable: example -``` diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc index ab22264..722272c 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc @@ -7,67 +7,46 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if condition == "yes" %} condition is yes {% endif %} params: condition: - type: variable variable: _.condition description: if condition is yes sub_family: # a subfamily var1: # a variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The variable use has condition. + -**Default**: no +**Défaut**: no |==== === possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ==== a subfamily `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.sub_family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - family: - sub_family: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - family: - sub_family: - var1: example ----- diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md index 11a235b..0b2886f 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md @@ -11,56 +11,35 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if condition == "yes" %} condition is yes {% endif %} params: condition: - type: variable variable: _.condition description: if condition is yes sub_family: # a subfamily var1: # a variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: no | ## possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ### a subfamily `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - family: - sub_family: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - family: - sub_family: - var1: example -``` diff --git a/tests/docs/base/24_0family_mandatory_condition.adoc b/tests/docs/base/24_0family_mandatory_condition.adoc index 3e9e632..bc10e56 100644 --- a/tests/docs/base/24_0family_mandatory_condition.adoc +++ b/tests/docs/base/24_0family_mandatory_condition.adoc @@ -7,36 +7,27 @@ condition: no # a condition var: description: a variable mandatory: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: only if rougail.condition has the value "yes" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="110a,110a",options="header"] +[cols="112a,112a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`obligatoire`_ | A variable. + -**Mandatory**: only if rougail.condition has the value "yes". +**Obligatoire**: only if rougail.condition has the value "yes". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - var: example ----- diff --git a/tests/docs/base/24_0family_mandatory_condition.md b/tests/docs/base/24_0family_mandatory_condition.md index d0aa5af..67f8296 100644 --- a/tests/docs/base/24_0family_mandatory_condition.md +++ b/tests/docs/base/24_0family_mandatory_condition.md @@ -11,26 +11,17 @@ condition: no # a condition var: description: a variable mandatory: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes {% endif %} description: only if rougail.condition has the value "yes" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`obligatoire`_ | A variable.
**Obligatoire**: only if rougail.condition has the value "yes". | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - var: example -``` diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.adoc b/tests/docs/base/24_0family_mandatory_condition_variable.adoc index d345263..6ca9aab 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/base/24_0family_mandatory_condition_variable.adoc @@ -7,32 +7,23 @@ condition: true # a condition var: description: a variable mandatory: - type: variable variable: _.condition ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="110a,110a",options="header"] +[cols="112a,112a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: True +**Défaut**: True | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`obligatoire`_ | A variable. + -**Mandatory**: when the variable "rougail.condition" has the value "True". +**Obligatoire**: when the variable "rougail.condition" has the value "True". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: true - var: example ----- diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.md b/tests/docs/base/24_0family_mandatory_condition_variable.md index abc5030..ca2cecd 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.md +++ b/tests/docs/base/24_0family_mandatory_condition_variable.md @@ -11,22 +11,13 @@ condition: true # a condition var: description: a variable mandatory: - type: variable variable: _.condition ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: when the variable "rougail.condition" has the value "True". | +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: True | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`obligatoire`_ | A variable.
**Obligatoire**: when the variable "rougail.condition" has the value "True". | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: true - var: example -``` diff --git a/tests/docs/base/24_family_disabled_var_hidden.adoc b/tests/docs/base/24_family_disabled_var_hidden.adoc new file mode 100644 index 0000000..fc4f78b --- /dev/null +++ b/tests/docs/base/24_family_disabled_var_hidden.adoc @@ -0,0 +1,16 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +---- diff --git a/tests/docs/base/24_family_disabled_var_hidden.md b/tests/docs/base/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..05c7bbb --- /dev/null +++ b/tests/docs/base/24_family_disabled_var_hidden.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +``` diff --git a/tests/docs/base/40_0leadership.adoc b/tests/docs/base/40_0leadership.adoc index be69ee7..3a0864d 100644 --- a/tests/docs/base/40_0leadership.adoc +++ b/tests/docs/base/40_0leadership.adoc @@ -3,16 +3,22 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader - multi: true + test: + - val1 + - val2 + follower1: # a follower + follower2: # an other follower ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -21,31 +27,25 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. + +**Exemples**: + +* val1 +* val2 | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +An other follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/base/40_0leadership.md b/tests/docs/base/40_0leadership.md index 94e71d6..dac5cec 100644 --- a/tests/docs/base/40_0leadership.md +++ b/tests/docs/base/40_0leadership.md @@ -7,16 +7,22 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader - multi: true + test: + - val1 + - val2 + follower1: # a follower + follower2: # an other follower ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -25,20 +31,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader.
**Exemples**:
- val1
- val2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | An other follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/base/40_0leadership_diff_name.adoc b/tests/docs/base/40_0leadership_diff_name.adoc index f4987c0..ceaa0d5 100644 --- a/tests/docs/base/40_0leadership_diff_name.adoc +++ b/tests/docs/base/40_0leadership_diff_name.adoc @@ -10,7 +10,7 @@ leadership: follower1: # a follower follower2: # an other follower ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -19,31 +19,21 @@ leadership: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **rougail.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. | **rougail.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +An other follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leadership: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/base/40_0leadership_diff_name.md b/tests/docs/base/40_0leadership_diff_name.md index f0e2d2c..2c29f8b 100644 --- a/tests/docs/base/40_0leadership_diff_name.md +++ b/tests/docs/base/40_0leadership_diff_name.md @@ -14,7 +14,7 @@ leadership: follower1: # a follower follower2: # an other follower ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -23,20 +23,10 @@ leadership: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | +| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | An other follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leadership: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_calculation.adoc index eb5a8c8..624b5d3 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_calculation.adoc @@ -11,12 +11,11 @@ leader: follower2: description: a second follower default: - type: jinja jinja: | {{ _.follower1 }} description: returns follower1 value ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -25,33 +24,23 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A follower. + -**Default**: value +**Défaut**: value | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second follower. + -**Default**: returns follower1 value. +**Défaut**: returns follower1 value. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: value - follower2: value ----- diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.md b/tests/docs/base/40_0leadership_follower_default_calculation.md index 159a117..17b1183 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.md +++ b/tests/docs/base/40_0leadership_follower_default_calculation.md @@ -15,12 +15,11 @@ leader: follower2: description: a second follower default: - type: jinja jinja: | {{ _.follower1 }} description: returns follower1 value ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -29,20 +28,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower.
**Défaut**: value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second follower.
**Défaut**: returns follower1 value. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: value - follower2: value -``` diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.adoc b/tests/docs/base/40_0leadership_follower_default_submulti.adoc index 248d31f..3215e23 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti.adoc @@ -14,7 +14,7 @@ leader: - value1 - value2 ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -23,44 +23,31 @@ leader: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A leader. + -**Default**: +**Défaut**: -* leader +* leader | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | A follower1. + -**Default**: +**Défaut**: -* value +* value | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | A follower2. + -**Default**: +**Défaut**: * value1 -* value2 +* value2 |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: leader - follower1: - - value - follower2: - - value1 - - value2 ----- diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.md b/tests/docs/base/40_0leadership_follower_default_submulti.md index 01b7b44..0651517 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.md +++ b/tests/docs/base/40_0leadership_follower_default_submulti.md @@ -18,7 +18,7 @@ leader: - value1 - value2 ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -27,23 +27,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- leader | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower1.
**Default**:
- value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A follower2.
**Default**:
- value1
- value2 | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A leader.
**Défaut**:
- leader | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | A follower1.
**Défaut**:
- value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | A follower2.
**Défaut**:
- value1
- value2 | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: leader - follower1: - - value - follower2: - - value1 - - value2 -``` diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc index 35a0d33..5dbffbc 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc @@ -14,10 +14,9 @@ leader: description: the follower2 multi: true default: - type: variable variable: _.follower1 ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -26,40 +25,28 @@ leader: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The leader. + -**Default**: +**Défaut**: -* leader +* leader | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | The follower1. + -**Default**: +**Défaut**: -* value +* value | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | The follower2. + -**Default**: the value of the variable "rougail.leader.follower1". +**Défaut**: la valeur de la variable "rougail.leader.follower1". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: leader - follower1: - - value - follower2: - - value ----- diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md index 30ff924..c65a1d4 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md @@ -18,10 +18,9 @@ leader: description: the follower2 multi: true default: - type: variable variable: _.follower1 ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -30,22 +29,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The leader.
**Default**:
- leader | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower1.
**Default**:
- value | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The follower2.
**Default**: the value of the variable "rougail.leader.follower1". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The leader.
**Défaut**:
- leader | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | The follower1.
**Défaut**:
- value | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | The follower2.
**Défaut**: la valeur de la variable "rougail.leader.follower1". | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: leader - follower1: - - value - follower2: - - value -``` diff --git a/tests/docs/base/40_0leadership_follower_default_value.adoc b/tests/docs/base/40_0leadership_follower_default_value.adoc index fd72282..a062b82 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.adoc +++ b/tests/docs/base/40_0leadership_follower_default_value.adoc @@ -12,7 +12,7 @@ leader: mandatory: false follower1: value # a follower with default value ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -21,27 +21,18 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A follower with default value. + -**Default**: value +**Défaut**: value |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: value ----- diff --git a/tests/docs/base/40_0leadership_follower_default_value.md b/tests/docs/base/40_0leadership_follower_default_value.md index 08228ee..61a37cf 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.md +++ b/tests/docs/base/40_0leadership_follower_default_value.md @@ -16,7 +16,7 @@ leader: mandatory: false follower1: value # a follower with default value ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -25,18 +25,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower with default value.
**Défaut**: value | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: value -``` diff --git a/tests/docs/base/40_0leadership_leader_not_multi.adoc b/tests/docs/base/40_0leadership_leader_not_multi.adoc new file mode 100644 index 0000000..33666ec --- /dev/null +++ b/tests/docs/base/40_0leadership_leader_not_multi.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +---- +== Variables pour "rougail" + +=== rougail.general + +`standard` + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**rougail.general.mode_conteneur_actif** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +No change. + +**Défaut**: non +|==== + +=== rougail.general1 + +`basic` + +==== rougail.general1.leader + +`basic` + + +This family contains lists of variable blocks. + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**rougail.general1.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +Leader. +| +**rougail.general1.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Follower1. +| +**rougail.general1.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Follower2. +|==== + + diff --git a/tests/docs/base/40_0leadership_leader_not_multi.md b/tests/docs/base/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..4960ea1 --- /dev/null +++ b/tests/docs/base/40_0leadership_leader_not_multi.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +``` +# Variables pour "rougail" + +## rougail.general + +`standard` + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | No change.
**Défaut**: non | + +## rougail.general1 + +`basic` + +### rougail.general1.leader + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | Leader. | +| **rougail.general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Follower1. | +| **rougail.general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Follower2. | + + diff --git a/tests/docs/base/40_1leadership_append_follower.adoc b/tests/docs/base/40_1leadership_append_follower.adoc index a4edb3f..6329f11 100644 --- a/tests/docs/base/40_1leadership_append_follower.adoc +++ b/tests/docs/base/40_1leadership_append_follower.adoc @@ -23,7 +23,7 @@ leader: follower2: description: the follower2 ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -32,36 +32,25 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The leader. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower1. | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower2. | **rougail.leader.follower3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower3. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower3. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: example - follower2: example - follower3: example ----- diff --git a/tests/docs/base/40_1leadership_append_follower.md b/tests/docs/base/40_1leadership_append_follower.md index b0f427d..3535a60 100644 --- a/tests/docs/base/40_1leadership_append_follower.md +++ b/tests/docs/base/40_1leadership_append_follower.md @@ -27,7 +27,7 @@ leader: follower2: description: the follower2 ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -36,22 +36,11 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | -| **rougail.leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower1. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower2. | +| **rougail.leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower3. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: example - follower2: example - follower3: example -``` diff --git a/tests/docs/base/40_2leadership_calculation_index.adoc b/tests/docs/base/40_2leadership_calculation_index.adoc index 18bdbaf..6b1b587 100644 --- a/tests/docs/base/40_2leadership_calculation_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_index.adoc @@ -16,7 +16,7 @@ leader: default: type: index ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -25,36 +25,23 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A leader. + -**Default**: +**Défaut**: * a * b -* c +* c | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A follower. + -**Default**: value of the index. +**Défaut**: la valeur de index. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: a - follower1: 2 - - leader: b - follower1: 2 - - leader: c - follower1: 2 ----- diff --git a/tests/docs/base/40_2leadership_calculation_index.md b/tests/docs/base/40_2leadership_calculation_index.md index ea29ff8..f9288d0 100644 --- a/tests/docs/base/40_2leadership_calculation_index.md +++ b/tests/docs/base/40_2leadership_calculation_index.md @@ -20,7 +20,7 @@ leader: default: type: index ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -29,22 +29,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | -| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value of the index. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A leader.
**Défaut**:
- a
- b
- c | +| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower.
**Défaut**: la valeur de index. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: a - follower1: 2 - - leader: b - follower1: 2 - - leader: c - follower1: 2 -``` diff --git a/tests/docs/base/40_2leadership_calculation_param_index.adoc b/tests/docs/base/40_2leadership_calculation_param_index.adoc index ba3b817..e37c6b5 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_param_index.adoc @@ -14,14 +14,13 @@ leader: description: a follower type: number default: - type: jinja jinja: '{{ index }}' params: index: type: index description: returns index ---- -== Variables for "rougail" +== Variables pour "rougail" === leadership @@ -30,36 +29,23 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A leader. + -**Default**: +**Défaut**: * a * b -* c +* c | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A follower. + -**Default**: returns index. +**Défaut**: returns index. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: a - follower1: 2 - - leader: b - follower1: 2 - - leader: c - follower1: 2 ----- diff --git a/tests/docs/base/40_2leadership_calculation_param_index.md b/tests/docs/base/40_2leadership_calculation_param_index.md index 38a542b..be61192 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.md +++ b/tests/docs/base/40_2leadership_calculation_param_index.md @@ -18,14 +18,13 @@ leader: description: a follower type: number default: - type: jinja jinja: '{{ index }}' params: index: type: index description: returns index ``` -# Variables for "rougail" +# Variables pour "rougail" ## leadership @@ -34,22 +33,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b
- c | -| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: returns index. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A leader.
**Défaut**:
- a
- b
- c | +| **rougail.leader.follower1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower.
**Défaut**: returns index. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: a - follower1: 2 - - leader: b - follower1: 2 - - leader: c - follower1: 2 -``` diff --git a/tests/docs/base/40_2leadership_leader_calculation.adoc b/tests/docs/base/40_2leadership_leader_calculation.adoc index 13f6b10..49c2c87 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.adoc +++ b/tests/docs/base/40_2leadership_leader_calculation.adoc @@ -3,22 +3,25 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true default: - type: jinja jinja: | val1 val2 description: returns val1 and val2 + follower1: # a first follower + follower2: # a second follower ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -27,35 +30,22 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A leader. + -**Default**: returns val1 and val2. +**Défaut**: returns val1 and val2. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first follower. | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A second follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: val1 - follower1: example - follower2: example - - leader: val2 - follower1: example - follower2: example ----- diff --git a/tests/docs/base/40_2leadership_leader_calculation.md b/tests/docs/base/40_2leadership_leader_calculation.md index 10b3580..d96fb6d 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.md +++ b/tests/docs/base/40_2leadership_leader_calculation.md @@ -7,22 +7,25 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true default: - type: jinja jinja: | val1 val2 description: returns val1 and val2 + follower1: # a first follower + follower2: # a second follower ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -31,23 +34,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**: returns val1 and val2. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first follower. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A leader.
**Défaut**: returns val1 and val2. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first follower. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: val1 - follower1: example - follower2: example - - leader: val2 - follower1: example - follower2: example -``` diff --git a/tests/docs/base/40_6leadership_follower_multi.adoc b/tests/docs/base/40_6leadership_follower_multi.adoc index d02c6c8..4dbee56 100644 --- a/tests/docs/base/40_6leadership_follower_multi.adoc +++ b/tests/docs/base/40_6leadership_follower_multi.adoc @@ -18,7 +18,7 @@ leadership: default: - value ---- -== Variables for "rougail" +== Variables pour "rougail" === A leadership @@ -27,36 +27,24 @@ leadership: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The leader. | **rougail.leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | -The first follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `multiple` | +The first follower. | **rougail.leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | The second follower. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leadership: - - leader: example - follower1: - - example - follower2: - - value ----- diff --git a/tests/docs/base/40_6leadership_follower_multi.md b/tests/docs/base/40_6leadership_follower_multi.md index 01c7ecc..6e849c0 100644 --- a/tests/docs/base/40_6leadership_follower_multi.md +++ b/tests/docs/base/40_6leadership_follower_multi.md @@ -22,7 +22,7 @@ leadership: default: - value ``` -# Variables for "rougail" +# Variables pour "rougail" ## A leadership @@ -31,22 +31,10 @@ leadership: This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | -| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**:
- value | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The leader. | +| **rougail.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `multiple` | The first follower. | +| **rougail.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | The second follower.
**Défaut**:
- value | -# Example with all variables modifiable - -```yaml ---- -rougail: - leadership: - - leader: example - follower1: - - example - follower2: - - value -``` diff --git a/tests/docs/base/40_8calculation_boolean.adoc b/tests/docs/base/40_8calculation_boolean.adoc index 8cfed9c..19b1e25 100644 --- a/tests/docs/base/40_8calculation_boolean.adoc +++ b/tests/docs/base/40_8calculation_boolean.adoc @@ -9,7 +9,6 @@ multi1: type: boolean multi: true default: - type: jinja jinja: | {% if _.bool %} True @@ -23,7 +22,6 @@ multi2: type: boolean multi: true default: - type: jinja jinja: | {% if not _.bool %} True @@ -33,38 +31,26 @@ multi2: {% endif %} description: a calculation ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="129a,129a",options="header"] +[cols="131a,131a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A boolean variable. + -**Default**: False +**Défaut**: False | **rougail.multi1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | A first multi variable. + -**Default**: a calculation. +**Défaut**: a calculation. | **rougail.multi2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | A second multi variable. + -**Default**: a calculation. +**Défaut**: a calculation. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - bool: false - multi1: - - false - multi2: - - true - - false ----- diff --git a/tests/docs/base/40_8calculation_boolean.md b/tests/docs/base/40_8calculation_boolean.md index 46f570c..d37d8e0 100644 --- a/tests/docs/base/40_8calculation_boolean.md +++ b/tests/docs/base/40_8calculation_boolean.md @@ -13,7 +13,6 @@ multi1: type: boolean multi: true default: - type: jinja jinja: | {% if _.bool %} True @@ -27,7 +26,6 @@ multi2: type: boolean multi: true default: - type: jinja jinja: | {% if not _.bool %} True @@ -37,24 +35,12 @@ multi2: {% endif %} description: a calculation ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                        | Description                                                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | -| **rougail.multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | -| **rougail.multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | +| Variable                                                                                                                          | Description                                                                                                                       | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A boolean variable.
**Défaut**: False | +| **rougail.multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first multi variable.
**Défaut**: a calculation. | +| **rougail.multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second multi variable.
**Défaut**: a calculation. | -# Example with all variables modifiable - -```yaml ---- -rougail: - bool: false - multi1: - - false - multi2: - - true - - false -``` diff --git a/tests/docs/base/40_8calculation_boolean_return_none.adoc b/tests/docs/base/40_8calculation_boolean_return_none.adoc index 6679d73..671b393 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.adoc +++ b/tests/docs/base/40_8calculation_boolean_return_none.adoc @@ -8,43 +8,27 @@ var2: description: a second variable type: boolean default: - type: jinja jinja: | {% if rougail.var1 == 'no' %} false {% endif %} description: return false if the value of var1 is "no" ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="109a,109a",options="header"] +[cols="111a,111a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: yes +**Défaut**: yes | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A second variable. + -**Default**: return false if the value of var1 is "no". +**Défaut**: return false if the value of var1 is "no". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var2: xxx ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: yes - var2: xxx ----- diff --git a/tests/docs/base/40_8calculation_boolean_return_none.md b/tests/docs/base/40_8calculation_boolean_return_none.md index 8487837..5ec805f 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.md +++ b/tests/docs/base/40_8calculation_boolean_return_none.md @@ -12,33 +12,17 @@ var2: description: a second variable type: boolean default: - type: jinja jinja: | {% if rougail.var1 == 'no' %} false {% endif %} description: return false if the value of var1 is "no" ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                    | Description                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: yes | -| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: return false if the value of var1 is "no". | +| Variable                                                                                                      | Description                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: yes | +| **rougail.var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: return false if the value of var1 is "no". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var2: xxx -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: yes - var2: xxx -``` diff --git a/tests/docs/base/40_8calculation_integer.adoc b/tests/docs/base/40_8calculation_integer.adoc index 1e2d84a..09c918a 100644 --- a/tests/docs/base/40_8calculation_integer.adoc +++ b/tests/docs/base/40_8calculation_integer.adoc @@ -8,7 +8,6 @@ int1: description: first integer variable type: number default: - type: jinja jinja: | {% if rougail.bool %}1{% else %}2{% endif %} description: if bool returns 1 otherwise return 2 @@ -16,40 +15,30 @@ int2: description: second integer variable type: number default: - type: jinja jinja: | {% if not rougail.bool %}3{% else %}4{% endif %} description: if bool returns 3 otherwise return 4 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A boolean variable. + -**Default**: False +**Défaut**: False | **rougail.int1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | First integer variable. + -**Default**: if bool returns 1 otherwise return 2. +**Défaut**: if bool returns 1 otherwise return 2. | **rougail.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | Second integer variable. + -**Default**: if bool returns 3 otherwise return 4. +**Défaut**: if bool returns 3 otherwise return 4. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - bool: false - int1: 2 - int2: 3 ----- diff --git a/tests/docs/base/40_8calculation_integer.md b/tests/docs/base/40_8calculation_integer.md index ba102b4..6151458 100644 --- a/tests/docs/base/40_8calculation_integer.md +++ b/tests/docs/base/40_8calculation_integer.md @@ -12,7 +12,6 @@ int1: description: first integer variable type: number default: - type: jinja jinja: | {% if rougail.bool %}1{% else %}2{% endif %} description: if bool returns 1 otherwise return 2 @@ -20,26 +19,16 @@ int2: description: second integer variable type: number default: - type: jinja jinja: | {% if not rougail.bool %}3{% else %}4{% endif %} description: if bool returns 3 otherwise return 4 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | -| **rougail.int1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | First integer variable.
**Default**: if bool returns 1 otherwise return 2. | -| **rougail.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Second integer variable.
**Default**: if bool returns 3 otherwise return 4. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A boolean variable.
**Défaut**: False | +| **rougail.int1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | First integer variable.
**Défaut**: if bool returns 1 otherwise return 2. | +| **rougail.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Second integer variable.
**Défaut**: if bool returns 3 otherwise return 4. | -# Example with all variables modifiable - -```yaml ---- -rougail: - bool: false - int1: 2 - int2: 3 -``` diff --git a/tests/docs/base/40_8calculation_multi_variable.adoc b/tests/docs/base/40_8calculation_multi_variable.adoc index eb2c83c..71907d0 100644 --- a/tests/docs/base/40_8calculation_multi_variable.adoc +++ b/tests/docs/base/40_8calculation_multi_variable.adoc @@ -6,47 +6,34 @@ version: '1.1' var: description: a first variable default: - - type: variable - variable: _.var2 - - type: variable - variable: _.var3 + - variable: _.var2 + - variable: _.var3 var2: no # a second variable var3: yes # a third variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: -* the value of the variable "rougail.var2". -* the value of the variable "rougail.var3". +* la valeur de la variable "rougail.var2". +* la valeur de la variable "rougail.var3". | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A third variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - no - - yes - var2: no - var3: yes ----- diff --git a/tests/docs/base/40_8calculation_multi_variable.md b/tests/docs/base/40_8calculation_multi_variable.md index 62fbbe7..04c3f0f 100644 --- a/tests/docs/base/40_8calculation_multi_variable.md +++ b/tests/docs/base/40_8calculation_multi_variable.md @@ -10,30 +10,17 @@ version: '1.1' var: description: a first variable default: - - type: variable - variable: _.var2 - - type: variable - variable: _.var3 + - variable: _.var2 + - variable: _.var3 var2: no # a second variable var3: yes # a third variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "rougail.var2".
- the value of the variable "rougail.var3". | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- la valeur de la variable "rougail.var2".
- la valeur de la variable "rougail.var3". | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - no - - yes - var2: no - var3: yes -``` diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.adoc b/tests/docs/base/40_8calculation_multi_variable_parent.adoc index a084c16..918156f 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent.adoc @@ -8,42 +8,32 @@ fam1: # a family var: description: a calculated variable default: - type: variable variable: __.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no |==== === a family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A calculated variable. + -**Default**: the value of the variable "rougail.var". +**Défaut**: la valeur de la variable "rougail.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: no - fam1: - var: no ----- diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.md b/tests/docs/base/40_8calculation_multi_variable_parent.md index 960cedd..42e608e 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.md +++ b/tests/docs/base/40_8calculation_multi_variable_parent.md @@ -12,30 +12,20 @@ fam1: # a family var: description: a calculated variable default: - type: variable variable: __.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | ## a family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "rougail.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A calculated variable.
**Défaut**: la valeur de la variable "rougail.var". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: no - fam1: - var: no -``` diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc index 34d6639..c81e402 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc @@ -9,47 +9,36 @@ fam2: # second family var: description: a varaible default: - type: variable variable: __.fam1.var ---- -== Variables for "rougail" +== Variables pour "rougail" === first family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no |==== === second family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.fam2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A varaible. + -**Default**: the value of the variable "rougail.fam1.var". +**Défaut**: la valeur de la variable "rougail.fam1.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - fam1: - var: no - fam2: - var: no ----- diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.md b/tests/docs/base/40_8calculation_multi_variable_parent2.md index e1f9bcb..b88baf7 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.md +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.md @@ -13,35 +13,24 @@ fam2: # second family var: description: a varaible default: - type: variable variable: __.fam1.var ``` -# Variables for "rougail" +# Variables pour "rougail" ## first family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | ## second family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "rougail.fam1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A varaible.
**Défaut**: la valeur de la variable "rougail.fam1.var". | -# Example with all variables modifiable - -```yaml ---- -rougail: - fam1: - var: no - fam2: - var: no -``` diff --git a/tests/docs/base/41_0choice_leader.adoc b/tests/docs/base/41_0choice_leader.adoc index 22e691d..256c7ad 100644 --- a/tests/docs/base/41_0choice_leader.adoc +++ b/tests/docs/base/41_0choice_leader.adoc @@ -18,7 +18,7 @@ leader: - b - c ---- -== Variables for "rougail" +== Variables pour "rougail" === The leadership @@ -27,31 +27,22 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +The leader. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A follower. + -**Choices**: +**Choix**: * a * b -* c +* c |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: a_choice ----- diff --git a/tests/docs/base/41_0choice_leader.md b/tests/docs/base/41_0choice_leader.md index 12b543f..49656c0 100644 --- a/tests/docs/base/41_0choice_leader.md +++ b/tests/docs/base/41_0choice_leader.md @@ -22,7 +22,7 @@ leader: - b - c ``` -# Variables for "rougail" +# Variables pour "rougail" ## The leadership @@ -31,18 +31,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | -| **rougail.leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | +| **rougail.leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower.
**Choix**:
- a
- b
- c | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: a_choice -``` diff --git a/tests/docs/base/44_0leadership_hidden.adoc b/tests/docs/base/44_0leadership_hidden.adoc index 0045864..6035ae2 100644 --- a/tests/docs/base/44_0leadership_hidden.adoc +++ b/tests/docs/base/44_0leadership_hidden.adoc @@ -3,10 +3,17 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership hidden: true type: leadership - leader: [] # a leader - follower: # a follower + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/base/44_0leadership_hidden.md b/tests/docs/base/44_0leadership_hidden.md index 32576ab..626b112 100644 --- a/tests/docs/base/44_0leadership_hidden.md +++ b/tests/docs/base/44_0leadership_hidden.md @@ -7,10 +7,17 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership hidden: true type: leadership - leader: [] # a leader - follower: # a follower + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/base/44_0leadership_leader_hidden.adoc b/tests/docs/base/44_0leadership_leader_hidden.adoc index ab771fc..fbd2146 100644 --- a/tests/docs/base/44_0leadership_leader_hidden.adoc +++ b/tests/docs/base/44_0leadership_leader_hidden.adoc @@ -3,12 +3,18 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true hidden: true - follower: # a follower + mandatory: false + + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/base/44_0leadership_leader_hidden.md b/tests/docs/base/44_0leadership_leader_hidden.md index 252e154..a7690be 100644 --- a/tests/docs/base/44_0leadership_leader_hidden.md +++ b/tests/docs/base/44_0leadership_leader_hidden.md @@ -7,12 +7,18 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true hidden: true - follower: # a follower + mandatory: false + + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.adoc b/tests/docs/base/44_1leadership_append_hidden_follower.adoc index d7d8d3d..ef0f10f 100644 --- a/tests/docs/base/44_1leadership_append_hidden_follower.adoc +++ b/tests/docs/base/44_1leadership_append_hidden_follower.adoc @@ -4,7 +4,9 @@ ---- version: '1.1' leader: - follower3: # follower3 + follower3: + description: follower3 + mandatory: false ---- == dictionaries/rougail/00-base.yml @@ -18,6 +20,11 @@ leader: description: a leader multi: true hidden: true - follower1: # the follower1 - follower2: # the follower2 + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false ---- diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.md b/tests/docs/base/44_1leadership_append_hidden_follower.md index 673d765..87edbdd 100644 --- a/tests/docs/base/44_1leadership_append_hidden_follower.md +++ b/tests/docs/base/44_1leadership_append_hidden_follower.md @@ -8,7 +8,9 @@ include_toc: true --- version: '1.1' leader: - follower3: # follower3 + follower3: + description: follower3 + mandatory: false ``` # dictionaries/rougail/00-base.yml @@ -22,6 +24,11 @@ leader: description: a leader multi: true hidden: true - follower1: # the follower1 - follower2: # the follower2 + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false ``` diff --git a/tests/docs/base/44_4disabled_calcultion_follower.adoc b/tests/docs/base/44_4disabled_calcultion_follower.adoc index 7ffc47a..bcb3b4d 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.adoc +++ b/tests/docs/base/44_4disabled_calcultion_follower.adoc @@ -14,23 +14,22 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: True +**Défaut**: True |==== === a leadership @@ -40,31 +39,21 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | Aleader. + -**Default**: +**Défaut**: -* a +* a | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A follower. + -**Disabled**: if condition is yes. +**Désactivé**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: true - leader: - - leader: a - follower: example ----- diff --git a/tests/docs/base/44_4disabled_calcultion_follower.md b/tests/docs/base/44_4disabled_calcultion_follower.md index 62924ee..b9bf51b 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.md +++ b/tests/docs/base/44_4disabled_calcultion_follower.md @@ -18,18 +18,17 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | {% if rougail.condition == "yes" %} condition is yes {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: True | ## a leadership @@ -38,19 +37,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Aleader.
**Default**:
- a | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | Aleader.
**Défaut**:
- a | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A follower.
**Désactivé**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: true - leader: - - leader: a - follower: example -``` diff --git a/tests/docs/base/44_4leadership_mandatory.adoc b/tests/docs/base/44_4leadership_mandatory.adoc index e5abcb5..5612cfb 100644 --- a/tests/docs/base/44_4leadership_mandatory.adoc +++ b/tests/docs/base/44_4leadership_mandatory.adoc @@ -14,7 +14,7 @@ leader: description: a follower mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -28,7 +28,7 @@ This family contains lists of variable blocks. | Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | A leader. | **rougail.leader.follower1** + @@ -37,12 +37,3 @@ A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: example ----- diff --git a/tests/docs/base/44_4leadership_mandatory.md b/tests/docs/base/44_4leadership_mandatory.md index 0557d29..d8f0e1a 100644 --- a/tests/docs/base/44_4leadership_mandatory.md +++ b/tests/docs/base/44_4leadership_mandatory.md @@ -18,7 +18,7 @@ leader: description: a follower mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -29,16 +29,7 @@ This family contains lists of variable blocks. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | | **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: example -``` diff --git a/tests/docs/base/44_4leadership_mandatory_follower.adoc b/tests/docs/base/44_4leadership_mandatory_follower.adoc index 303146e..bfe4a2c 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/base/44_4leadership_mandatory_follower.adoc @@ -14,7 +14,7 @@ leader: description: a follower mandatory: true ---- -== Variables for "rougail" +== Variables pour "rougail" === a leadership @@ -23,26 +23,17 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower: example ----- diff --git a/tests/docs/base/44_4leadership_mandatory_follower.md b/tests/docs/base/44_4leadership_mandatory_follower.md index ab92f26..cdba4aa 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.md +++ b/tests/docs/base/44_4leadership_mandatory_follower.md @@ -18,7 +18,7 @@ leader: description: a follower mandatory: true ``` -# Variables for "rougail" +# Variables pour "rougail" ## a leadership @@ -27,18 +27,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower: example -``` diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc index a91a9e2..5da6a4e 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc @@ -11,56 +11,46 @@ leader: description: a leader multi: true hidden: - type: jinja jinja: | {% if __.condition == "no" %} condition is no {% endif %} description: if condition is no + mandatory: false follower: # a follower ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no |==== === a leadership -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is no. +**Caché**: if condition is no. This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: no - leader: - - leader: example - follower: example ----- diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.md b/tests/docs/base/44_5leadership_leader_hidden_calculation.md index b67ad17..3670eb8 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.md @@ -15,42 +15,32 @@ leader: description: a leader multi: true hidden: - type: jinja jinja: | {% if __.condition == "no" %} condition is no {% endif %} description: if condition is no + mandatory: false follower: # a follower ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | ## a leadership -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is no. +**Caché**: if condition is no. This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: no - leader: - - leader: example - follower: example -``` diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc index dcb824a..7b4460f 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc @@ -13,21 +13,22 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | - {% if __.condition == "yes" %}true{% else %}false{% endif %} + {% if __.condition == "yes" %} + disabled + {% endif %} description: if condition is yes ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes |==== === a leadership @@ -37,28 +38,18 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A follower. + -**Disabled**: if condition is yes. +**Désactivé**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - condition: yes - leader: - - leader: example - follower: example ----- diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.md b/tests/docs/base/44_6leadership_follower_disabled_calculation.md index bb0c8bb..0d76303 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.md @@ -17,16 +17,17 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | - {% if __.condition == "yes" %}true{% else %}false{% endif %} + {% if __.condition == "yes" %} + disabled + {% endif %} description: if condition is yes ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | ## a leadership @@ -35,19 +36,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A follower.
**Désactivé**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -rougail: - condition: yes - leader: - - leader: example - follower: example -``` diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.adoc b/tests/docs/base/44_9calculated_default_leadership_leader.adoc index ed8e633..939ce4d 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.adoc +++ b/tests/docs/base/44_9calculated_default_leadership_leader.adoc @@ -12,17 +12,15 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | {% if _.leader == "a" %} the value of "leader" is "a" {% endif %} description: if the value of "leader" is "a" default: - type: variable variable: _.leader ---- -== Variables for "rougail" +== Variables pour "rougail" === rougail.leader @@ -31,34 +29,23 @@ leader: This family contains lists of variable blocks. -[cols="121a,121a",options="header"] +[cols="124a,124a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A leader. + -**Default**: +**Défaut**: * a -* b +* b | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` _`désactivé`_ | A follower. + -**Default**: the value of the variable "rougail.leader.leader". + -**Disabled**: if the value of "leader" is "a". +**Défaut**: la valeur de la variable "rougail.leader.leader". + +**Désactivé**: if the value of "leader" is "a". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: a - follower: b - - leader: b - follower: b ----- diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.md b/tests/docs/base/44_9calculated_default_leadership_leader.md index 56ba732..523dde0 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.md +++ b/tests/docs/base/44_9calculated_default_leadership_leader.md @@ -16,17 +16,15 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | {% if _.leader == "a" %} the value of "leader" is "a" {% endif %} description: if the value of "leader" is "a" default: - type: variable variable: _.leader ``` -# Variables for "rougail" +# Variables pour "rougail" ## rougail.leader @@ -35,20 +33,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A follower.
**Default**: the value of the variable "rougail.leader.leader".
**Disabled**: if the value of "leader" is "a". | +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A leader.
**Défaut**:
- a
- b | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` _`désactivé`_ | A follower.
**Défaut**: la valeur de la variable "rougail.leader.leader".
**Désactivé**: if the value of "leader" is "a". | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: a - follower: b - - leader: b - follower: b -``` diff --git a/tests/docs/base/60_0family_dynamic.adoc b/tests/docs/base/60_0family_dynamic.adoc index 11abda8..902fa83 100644 --- a/tests/docs/base/60_0family_dynamic.adoc +++ b/tests/docs/base/60_0family_dynamic.adoc @@ -6,27 +6,25 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: # A dynamic variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -36,38 +34,15 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - var: example - dynval2: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example ----- diff --git a/tests/docs/base/60_0family_dynamic.md b/tests/docs/base/60_0family_dynamic.md index fb83089..badab4f 100644 --- a/tests/docs/base/60_0family_dynamic.md +++ b/tests/docs/base/60_0family_dynamic.md @@ -10,19 +10,17 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: # A dynamic variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -31,33 +29,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - var: example - dynval2: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example -``` diff --git a/tests/docs/base/60_0family_dynamic_1_0.adoc b/tests/docs/base/60_0family_dynamic_1_0.adoc index 56f8138..9e10959 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0.adoc @@ -16,16 +16,16 @@ dyn: description: Dynamic variable mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" [cols="96a,96a",options="header"] |==== | Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 * val2 @@ -38,7 +38,7 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". [cols="96a,96a",options="header"] |==== @@ -50,16 +50,3 @@ Dynamic variable. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example ----- diff --git a/tests/docs/base/60_0family_dynamic_1_0.md b/tests/docs/base/60_0family_dynamic_1_0.md index 6e09dc5..552d4e9 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.md +++ b/tests/docs/base/60_0family_dynamic_1_0.md @@ -20,11 +20,11 @@ dyn: description: Dynamic variable mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## "dyn*val1*" ou "dyn*val2*" @@ -33,23 +33,10 @@ dyn: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example -``` diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.adoc b/tests/docs/base/60_0family_dynamic_1_0_type.adoc index 3c05289..2432043 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0_type.adoc @@ -15,19 +15,19 @@ dyn: vardyn: description: A dyn variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === "dyn_val1_" ou "dyn_val2_" @@ -37,38 +37,15 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dyn variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dyn variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example ----- diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.md b/tests/docs/base/60_0family_dynamic_1_0_type.md index fe2dabc..8564e81 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.md +++ b/tests/docs/base/60_0family_dynamic_1_0_type.md @@ -19,11 +19,11 @@ dyn: vardyn: description: A dyn variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## "dyn*val1*" ou "dyn*val2*" @@ -32,33 +32,10 @@ dyn: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dyn variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dyn variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example -``` diff --git a/tests/docs/base/60_0family_dynamic_1_1.adoc b/tests/docs/base/60_0family_dynamic_1_1.adoc index f523b21..7eb361b 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.adoc +++ b/tests/docs/base/60_0family_dynamic_1_1.adoc @@ -13,19 +13,19 @@ dyn: vardyn: description: A dynamic variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -35,38 +35,15 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example ----- diff --git a/tests/docs/base/60_0family_dynamic_1_1.md b/tests/docs/base/60_0family_dynamic_1_1.md index b56acdb..c6b752a 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.md +++ b/tests/docs/base/60_0family_dynamic_1_1.md @@ -17,11 +17,11 @@ dyn: vardyn: description: A dynamic variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -30,33 +30,10 @@ dyn: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - vardyn: example - dynval2: - vardyn: example -``` diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.adoc b/tests/docs/base/60_0family_dynamic_jinja_number.adoc index 97ad40f..1606ed8 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.adoc +++ b/tests/docs/base/60_0family_dynamic_jinja_number.adoc @@ -6,34 +6,31 @@ version: '1.1' var: # a suffix variable - 1 - 2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family var2: description: a variable default: - type: jinja jinja: | {{ rougail.dyn1.var }} description: get the value of rougail.dyn1.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * 1 -* 2 +* 2 |==== === a dynamic family @@ -43,40 +40,26 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dyn1.var** ou **rougail.dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable inside dynamic family. + -**Default**: val +**Défaut**: val |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: get the value of rougail.dyn1.var. +**Défaut**: get the value of rougail.dyn1.var. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - 1 - - 2 - dyn1: - var: val - dyn2: - var: val - var2: val ----- diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.md b/tests/docs/base/60_0family_dynamic_jinja_number.md index 69e72d8..27f0999 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.md +++ b/tests/docs/base/60_0family_dynamic_jinja_number.md @@ -10,26 +10,23 @@ version: '1.1' var: # a suffix variable - 1 - 2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family var2: description: a variable default: - type: jinja jinja: | {{ rougail.dyn1.var }} description: get the value of rougail.dyn1.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- 1
- 2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- 1
- 2 | ## a dynamic family @@ -38,28 +35,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable inside dynamic family.
**Défaut**: val | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get the value of rougail.dyn1.var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: get the value of rougail.dyn1.var. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - 1 - - 2 - dyn1: - var: val - dyn2: - var: val - var2: val -``` diff --git a/tests/docs/base/60_0family_dynamic_static.adoc b/tests/docs/base/60_0family_dynamic_static.adoc index 0003bad..ebd2a09 100644 --- a/tests/docs/base/60_0family_dynamic_static.adoc +++ b/tests/docs/base/60_0family_dynamic_static.adoc @@ -3,15 +3,14 @@ [,yaml] ---- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 var: # a variable inside a dynamic family ---- -== Variables for "rougail" +== Variables pour "rougail" === a dynamic family @@ -20,38 +19,18 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 * val2 -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable inside a dynamic family. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable inside a dynamic family. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - var: example - dynval2: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - dynval1: - var: example - dynval2: - var: example ----- diff --git a/tests/docs/base/60_0family_dynamic_static.md b/tests/docs/base/60_0family_dynamic_static.md index ab3165c..2af7674 100644 --- a/tests/docs/base/60_0family_dynamic_static.md +++ b/tests/docs/base/60_0family_dynamic_static.md @@ -7,15 +7,14 @@ include_toc: true ```yaml --- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 var: # a variable inside a dynamic family ``` -# Variables for "rougail" +# Variables pour "rougail" ## a dynamic family @@ -24,30 +23,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**:
- val1
- val2 +**Identifiers**:
- val1
- val2 -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable inside a dynamic family. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - var: example - dynval2: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - dynval1: - var: example - dynval2: - var: example -``` diff --git a/tests/docs/base/60_0family_dynamic_test.adoc b/tests/docs/base/60_0family_dynamic_test.adoc new file mode 100644 index 0000000..cefea64 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_test.adoc @@ -0,0 +1,54 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +---- +== Variables pour "rougail" + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A suffix variable. + +**Exemples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "rougail.var". + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. +|==== + + diff --git a/tests/docs/base/60_0family_dynamic_test.md b/tests/docs/base/60_0family_dynamic_test.md new file mode 100644 index 0000000..ca5fb08 --- /dev/null +++ b/tests/docs/base/60_0family_dynamic_test.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +``` +# Variables pour "rougail" + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A suffix variable.
**Exemples**:
- val1
- val2 | + +## A dynamic family + +`basic` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "rougail.var". + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | + + diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.adoc b/tests/docs/base/60_0family_dynamic_variable_empty.adoc index 96cab47..c9b6124 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_empty.adoc @@ -4,23 +4,21 @@ ---- version: '1.1' var: [] # a suffix variable -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A suffix variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A suffix variable. |==== === a dynamic family @@ -30,34 +28,16 @@ A suffix variable. This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynexample.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable inside dynamic family. + -**Default**: val +**Défaut**: val |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var: - - example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - example - dynexample: - var: val ----- diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.md b/tests/docs/base/60_0family_dynamic_variable_empty.md index 6857e87..4608bdc 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.md +++ b/tests/docs/base/60_0family_dynamic_variable_empty.md @@ -8,19 +8,17 @@ include_toc: true --- version: '1.1' var: [] # a suffix variable -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A suffix variable. | ## a dynamic family @@ -29,28 +27,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable inside dynamic family.
**Défaut**: val | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var: - - example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - example - dynexample: - var: val -``` diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc index 6117ab1..898e544 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc @@ -6,27 +6,25 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - var: a value # A dynamic variable with suffix {{ suffix }} + var: a value # A dynamic variable with suffix {{ identifier }} ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -36,29 +34,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | "A dynamic variable with suffix _val1_" ou "A dynamic variable with suffix _val2_". + -**Default**: a value +**Défaut**: a value |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - var: a value - dynval2: - var: a value ----- diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.md b/tests/docs/base/60_0family_dynamic_variable_suffix.md index 4a3e4a9..cf13bbb 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.md +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.md @@ -10,19 +10,17 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - var: a value # A dynamic variable with suffix {{ suffix }} + var: a value # A dynamic variable with suffix {{ identifier }} ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -31,23 +29,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Default**: a value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Défaut**: a value | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - var: a value - dynval2: - var: a value -``` diff --git a/tests/docs/base/60_0family_hidden.adoc b/tests/docs/base/60_0family_hidden.adoc index 95608e1..b55cefc 100644 --- a/tests/docs/base/60_0family_hidden.adoc +++ b/tests/docs/base/60_0family_hidden.adoc @@ -13,5 +13,7 @@ family: ---- version: '1.1' family: # a family - var: # a variable + var: + description: a variable + mandatory: false ---- diff --git a/tests/docs/base/60_0family_hidden.md b/tests/docs/base/60_0family_hidden.md index 92e412b..ee44f10 100644 --- a/tests/docs/base/60_0family_hidden.md +++ b/tests/docs/base/60_0family_hidden.md @@ -17,5 +17,7 @@ family: --- version: '1.1' family: # a family - var: # a variable + var: + description: a variable + mandatory: false ``` diff --git a/tests/docs/base/60_0family_mode.adoc b/tests/docs/base/60_0family_mode.adoc index 01ea2f8..770f352 100644 --- a/tests/docs/base/60_0family_mode.adoc +++ b/tests/docs/base/60_0family_mode.adoc @@ -9,28 +9,20 @@ family: # a family mode: basic default: non ---- -== Variables for "rougail" +== Variables pour "rougail" === a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | A variable. + -**Default**: non +**Défaut**: non |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - family: - var: non ----- diff --git a/tests/docs/base/60_0family_mode.md b/tests/docs/base/60_0family_mode.md index d79a412..dc31271 100644 --- a/tests/docs/base/60_0family_mode.md +++ b/tests/docs/base/60_0family_mode.md @@ -13,22 +13,14 @@ family: # a family mode: basic default: non ``` -# Variables for "rougail" +# Variables pour "rougail" ## a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable.
**Défaut**: non | -# Example with all variables modifiable - -```yaml ---- -rougail: - family: - var: non -``` diff --git a/tests/docs/base/60_1family_dynamic_jinja.adoc b/tests/docs/base/60_1family_dynamic_jinja.adoc index 0f8c6a5..54e3a55 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.adoc +++ b/tests/docs/base/60_1family_dynamic_jinja.adoc @@ -6,11 +6,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: jinja jinja: | {% for val in _.var %} {{ loop.index }} @@ -18,19 +16,19 @@ dyn{{ suffix }}: description: index of suffix value var: val # a dynamic variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -40,29 +38,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: index of suffix value. +**Identifiers**: index of suffix value. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dyn1.var** ou **rougail.dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: val +**Défaut**: val |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dyn1: - var: val - dyn2: - var: val ----- diff --git a/tests/docs/base/60_1family_dynamic_jinja.md b/tests/docs/base/60_1family_dynamic_jinja.md index e16426f..4c93f2b 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.md +++ b/tests/docs/base/60_1family_dynamic_jinja.md @@ -10,11 +10,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: jinja jinja: | {% for val in _.var %} {{ loop.index }} @@ -22,11 +20,11 @@ dyn{{ suffix }}: description: index of suffix value var: val # a dynamic variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -35,23 +33,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: index of suffix value. +**Identifiers**: index of suffix value. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn1.var** ou **rougail.dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: val | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dyn1: - var: val - dyn2: - var: val -``` diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc index c295149..26e2825 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -6,35 +6,32 @@ version: '1.1' var1: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 family: # a family var: # with a variable var2: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -44,58 +41,29 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". ==== a family `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -With a variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +With a variable. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - family: - var: example - dynval2: - family: - var: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - val1 - - val2 - dynval1: - family: - var: example - dynval2: - family: - var: example - var2: example ----- diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md index f1e7fc1..ee65905 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md @@ -10,27 +10,24 @@ version: '1.1' var1: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 family: # a family var: # with a variable var2: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -39,47 +36,18 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". ### a family `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | With a variable. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: the value of var. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - family: - var: example - dynval2: - family: - var: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - val1 - - val2 - dynval1: - family: - var: example - dynval2: - family: - var: example - var2: example -``` diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc index 1a4560d..71afe41 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -3,42 +3,39 @@ [,yaml] ---- version: '1.1' -var: # a suffix variable +var: # a identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var family: description: a family inside dynamic family var: description: a dynamic variable default: - type: suffix + type: identifier var2: description: a varible outside dynamic family default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A suffix variable. + -**Default**: +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A identifier variable. + +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -48,46 +45,30 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". ==== a family inside dynamic family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A varible outside dynamic family. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - family: - var: val1 - dynval2: - family: - var: val2 - var2: val1 ----- diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md index b10e63a..d1461dc 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -7,34 +7,31 @@ include_toc: true ```yaml --- version: '1.1' -var: # a suffix variable +var: # a identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var family: description: a family inside dynamic family var: description: a dynamic variable default: - type: suffix + type: identifier var2: description: a varible outside dynamic family default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A identifier variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -43,34 +40,18 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". ### a family inside dynamic family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: la valeur de identifier. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A varible outside dynamic family.
**Défaut**: the value of var. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - family: - var: val1 - dynval2: - family: - var: val2 - var2: val1 -``` diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.adoc b/tests/docs/base/60_2family_dynamic_outside_calc.adoc index 76655c7..af76928 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/base/60_2family_dynamic_outside_calc.adoc @@ -6,34 +6,31 @@ version: '1.1' var1: # a suffx variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 var: val # a dynamic variable newvar: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.var }} description: the value of var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffx variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -43,40 +40,26 @@ A suffx variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: val +**Défaut**: val |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.newvar** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - val1 - - val2 - dynval1: - var: val - dynval2: - var: val - newvar: val ----- diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.md b/tests/docs/base/60_2family_dynamic_outside_calc.md index 47a485d..0f26c6b 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.md +++ b/tests/docs/base/60_2family_dynamic_outside_calc.md @@ -10,26 +10,23 @@ version: '1.1' var1: # a suffx variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 var: val # a dynamic variable newvar: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.var }} description: the value of var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffx variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -38,28 +35,14 @@ newvar: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: val | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: the value of var. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - val1 - - val2 - dynval1: - var: val - dynval2: - var: val - newvar: val -``` diff --git a/tests/docs/base/60_5family_dynamic_calc2.adoc b/tests/docs/base/60_5family_dynamic_calc2.adoc index 7ab3b18..55dc7ec 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc2.adoc @@ -3,86 +3,64 @@ [,yaml] ---- version: '1.1' + var: # A suffix variable - val1 - val2 + var2: # a second variable -dyn{{ suffix }}: + +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - propertyerror: false hidden: - type: jinja -#FIXME RELATIVE __.var2 jinja: | - {% if rougail.var2 == "no" %} + {% if _.var2 == "no" %} var2 is no {% endif %} description: if var2 is no + vardyn: val # a dynamic variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A second variable. |==== === A dynamic family -`standard` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if var2 is no. +**Caché**: if var2 is no. This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: val +**Défaut**: val |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - var2: example - dynval1: - vardyn: val - dynval2: - vardyn: val ----- diff --git a/tests/docs/base/60_5family_dynamic_calc2.md b/tests/docs/base/60_5family_dynamic_calc2.md index e7cca06..66a1744 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.md +++ b/tests/docs/base/60_5family_dynamic_calc2.md @@ -7,68 +7,46 @@ include_toc: true ```yaml --- version: '1.1' + var: # A suffix variable - val1 - val2 + var2: # a second variable -dyn{{ suffix }}: + +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - propertyerror: false hidden: - type: jinja -#FIXME RELATIVE __.var2 jinja: | - {% if rougail.var2 == "no" %} + {% if _.var2 == "no" %} var2 is no {% endif %} description: if var2 is no + vardyn: val # a dynamic variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second variable. | ## A dynamic family -`standard` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if var2 is no. +**Caché**: if var2 is no. This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: val | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - var2: example - dynval1: - vardyn: val - dynval2: - vardyn: val -``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc index 16cae1e..f728663 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc @@ -3,44 +3,38 @@ [,yaml] ---- version: '1.1' + var1: description: A suffix variable default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic + +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 - propertyerror: false + var: description: A dynamic variable + var2: description: A variable calculated default: - type: jinja - jinja: | - {{ vardyn }} - params: - vardyn: - type: variable - variable: rougail.dynval1.var - description: from rougail.dynval1.var + variable: rougail.dynval1.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === "dyn_val1_" ou "dyn_val2_" @@ -50,50 +44,25 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable calculated. + -**Default**: from rougail.dynval1.var. +**Défaut**: la valeur de la variable "rougail.dynval1.var". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - var: example - dynval2: - var: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example - var2: example ----- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.md b/tests/docs/base/60_5family_dynamic_calc_suffix.md index c10a408..f706cc6 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.md @@ -7,36 +7,30 @@ include_toc: true ```yaml --- version: '1.1' + var1: description: A suffix variable default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic + +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 - propertyerror: false + var: description: A dynamic variable + var2: description: A variable calculated default: - type: jinja - jinja: | - {{ vardyn }} - params: - vardyn: - type: variable - variable: rougail.dynval1.var - description: from rougail.dynval1.var + variable: rougail.dynval1.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## "dyn*val1*" ou "dyn*val2*" @@ -45,39 +39,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: from rougail.dynval1.var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable calculated.
**Défaut**: la valeur de la variable "rougail.dynval1.var". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - var: example - dynval2: - var: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example - var2: example -``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc index cf7ff07..d194b77 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc @@ -6,30 +6,28 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: Suffix has value default: - type: suffix + type: identifier ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -39,29 +37,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Suffix has value. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - var: val1 - dynval2: - var: val2 ----- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.md b/tests/docs/base/60_5family_dynamic_calc_suffix2.md index f4580f6..17e07fa 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.md @@ -10,22 +10,20 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: Suffix has value default: - type: suffix + type: identifier ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -34,23 +32,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Suffix has value.
**Défaut**: la valeur de identifier. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - var: val1 - dynval2: - var: val2 -``` diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc new file mode 100644 index 0000000..358ab6e --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc @@ -0,0 +1,40 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +dyn{{ identifier }}: + dynamic: + - val1 + - val2 + var: + description: A dynamic variable + disabled: + type: identifier + when: val1 +---- +== Variables pour "rougail" + +=== "dyn_val1_" ou "dyn_val2_" + +`basic` + + +This family builds families dynamically. + +**Identifiers**: + +* val1 +* val2 + +[cols="121a,121a",options="header"] +|==== +| Variable | Description +| +**rougail.dynval1.var** ou **rougail.dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | +A dynamic variable. + +**Désactivé**: when the identifier is "val1". +|==== + + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md new file mode 100644 index 0000000..d55bf77 --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +dyn{{ identifier }}: + dynamic: + - val1 + - val2 + var: + description: A dynamic variable + disabled: + type: identifier + when: val1 +``` +# Variables pour "rougail" + +## "dyn*val1*" ou "dyn*val2*" + +`basic` + + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A dynamic variable.
**Désactivé**: when the identifier is "val1". | + + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc index 2ed4414..9fdd98b 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc @@ -3,39 +3,36 @@ [,yaml] ---- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable default: - type: jinja jinja: | - {{ suffix }} + {{ identifier }} params: - suffix: - type: suffix + identifier: + type: identifier description: from suffix ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A suffix variable. + -**Default**: +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A identifier variable. + +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -45,29 +42,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: from suffix. +**Défaut**: from suffix. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - var: val1 - dynval2: - var: val2 ----- diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md index 12f063e..c6a3846 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.md @@ -7,31 +7,28 @@ include_toc: true ```yaml --- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable default: - type: jinja jinja: | - {{ suffix }} + {{ identifier }} params: - suffix: - type: suffix + identifier: + type: identifier description: from suffix ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A identifier variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -40,23 +37,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: from suffix. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - var: val1 - dynval2: - var: val2 -``` diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.adoc b/tests/docs/base/60_5family_dynamic_calc_variable.adoc index b6a56d9..0632e74 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_variable.adoc @@ -8,10 +8,8 @@ var1: default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 propertyerror: false var: @@ -19,22 +17,21 @@ dyn{{ suffix }}: var2: description: A variable calculated default: - type: variable variable: _.dynval1.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === "dyn_val1_" ou "dyn_val2_" @@ -44,50 +41,25 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable calculated. + -**Default**: the value of the variable "rougail.dynval1.var". +**Défaut**: la valeur de la variable "rougail.dynval1.var". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - var: example - dynval2: - var: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var1: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example - var2: example ----- diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.md b/tests/docs/base/60_5family_dynamic_calc_variable.md index b9f270a..a9161f6 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.md +++ b/tests/docs/base/60_5family_dynamic_calc_variable.md @@ -12,10 +12,8 @@ var1: default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 propertyerror: false var: @@ -23,14 +21,13 @@ dyn{{ suffix }}: var2: description: A variable calculated default: - type: variable variable: _.dynval1.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## "dyn*val1*" ou "dyn*val2*" @@ -39,39 +36,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var1". +**Identifiers**: la valeur de la variable "rougail.var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "rougail.dynval1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable calculated.
**Défaut**: la valeur de la variable "rougail.dynval1.var". | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - var: example - dynval2: - var: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var1: - - val1 - - val2 - dynval1: - var: example - dynval2: - var: example - var2: example -``` diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc index 0b33d3e..daee4a4 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc @@ -3,91 +3,65 @@ [,yaml] ---- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 hidden: - type: jinja jinja: | {% if suffix == 'val2' %} disabled {% endif %} params: suffix: - type: suffix + type: identifier description: if suffix == 'val2' - var: # a variable + var: + description: a variable + mandatory: false family: # a family - var: # a new variable + var: + description: a new variable + mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" === a dynamic family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if suffix == 'val2'. +**Caché**: if suffix == 'val2'. This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 * val2 -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== ==== a family -`basic` +`standard` -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.family.var** ou **rougail.dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A new variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A new variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - var: example - family: - var: example - dynval2: - var: example - family: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - dynval1: - var: example - family: - var: example - dynval2: - var: example - family: - var: example ----- diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.md b/tests/docs/base/60_5family_dynamic_hidden_suffix.md index b40ef1e..7f766eb 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.md @@ -7,78 +7,52 @@ include_toc: true ```yaml --- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 hidden: - type: jinja jinja: | {% if suffix == 'val2' %} disabled {% endif %} params: suffix: - type: suffix + type: identifier description: if suffix == 'val2' - var: # a variable + var: + description: a variable + mandatory: false family: # a family - var: # a new variable + var: + description: a new variable + mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" ## a dynamic family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if suffix == 'val2'. +**Caché**: if suffix == 'val2'. This family builds families dynamically. -**Suffixes**:
- val1
- val2 +**Identifiers**:
- val1
- val2 -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | ### a family -`basic` +`standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A new variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.family.var** ou **rougail.dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - var: example - family: - var: example - dynval2: - var: example - family: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - dynval1: - var: example - family: - var: example - dynval2: - var: example - family: - var: example -``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.adoc b/tests/docs/base/60_5family_dynamic_variable_outside.adoc index b86403f..9bd99ac 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside.adoc @@ -6,37 +6,34 @@ version: '1.1' var: # a suffix variable - val1 - val2 -my_dyn_family_{{ suffix }}: +my_dyn_family_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside a dynamic family default: - type: suffix + type: identifier mandatory: false var2: description: a variable multi: true default: - type: variable - variable: rougail.my_dyn_family_{{ suffix }}.var + variable: rougail.my_dyn_family_{{ identifier }}.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -46,42 +43,26 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A variable inside a dynamic family. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: the value of the variable "rougail.my_dyn_family_{{ suffix }}.var". +**Défaut**: la valeur de la variable "rougail.my_dyn_family_{{ identifier }}.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - my_dyn_family_val1: - var: val1 - my_dyn_family_val2: - var: val2 - var2: - - val1 - - val2 ----- diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.md b/tests/docs/base/60_5family_dynamic_variable_outside.md index aa91b0a..1b423f1 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.md +++ b/tests/docs/base/60_5family_dynamic_variable_outside.md @@ -10,29 +10,26 @@ version: '1.1' var: # a suffix variable - val1 - val2 -my_dyn_family_{{ suffix }}: +my_dyn_family_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside a dynamic family default: - type: suffix + type: identifier mandatory: false var2: description: a variable multi: true default: - type: variable - variable: rougail.my_dyn_family_{{ suffix }}.var + variable: rougail.my_dyn_family_{{ identifier }}.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -41,30 +38,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: value of the suffix. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Défaut**: la valeur de identifier. | -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: the value of the variable "rougail.my_dyn_family_{{ suffix }}.var". | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**: la valeur de la variable "rougail.my_dyn_family_{{ identifier }}.var". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - my_dyn_family_val1: - var: val1 - my_dyn_family_val2: - var: val2 - var2: - - val1 - - val2 -``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc new file mode 100644 index 0000000..8c4358a --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc @@ -0,0 +1,74 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + jinja: |- + {%- for v in var %} + {{ v }} + {%- endfor -%} + params: + var: + variable: rougail.my_dyn_family_{{ identifier }}.var +---- +== Variables pour "rougail" + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A suffix variable. + +**Défaut**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "rougail.var". + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Défaut**: la valeur de identifier. +|==== + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A variable. + +**Défaut**: depends on a calculation. +|==== + + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md new file mode 100644 index 0000000..b0b872f --- /dev/null +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md @@ -0,0 +1,57 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: # a suffix variable + - val1 + - val2 +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + jinja: |- + {%- for v in var %} + {{ v }} + {%- endfor -%} + params: + var: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +# Variables pour "rougail" + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | + +## a dynamic family + +`standard` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "rougail.var". + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_val1.var** ou **rougail.my_dyn_family_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Défaut**: la valeur de identifier. | + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**: depends on a calculation. | + + diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc index cd42f9a..80efcc7 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc @@ -6,35 +6,32 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn_{{ suffix }}: +dyn_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside dynamic family default: - type: suffix + type: identifier var2: description: a variable default: - type: variable variable: _.dyn_val1.var ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -44,40 +41,26 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dyn_val1.var** ou **rougail.dyn_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable inside dynamic family. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: the value of the variable "rougail.dyn_val1.var". +**Défaut**: la valeur de la variable "rougail.dyn_val1.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dyn_val1: - var: val1 - dyn_val2: - var: val2 - var2: val1 ----- diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md index b9232af..5de71f2 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md @@ -10,27 +10,24 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn_{{ suffix }}: +dyn_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside dynamic family default: - type: suffix + type: identifier var2: description: a variable default: - type: variable variable: _.dyn_val1.var ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -39,28 +36,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dyn_val1.var** ou **rougail.dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_val1.var** ou **rougail.dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable inside dynamic family.
**Défaut**: la valeur de identifier. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "rougail.dyn_val1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: la valeur de la variable "rougail.dyn_val1.var". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dyn_val1: - var: val1 - dyn_val2: - var: val2 - var2: val1 -``` diff --git a/tests/docs/base/60_6family_dynamic_inside.adoc b/tests/docs/base/60_6family_dynamic_inside.adoc index dad17fc..8e6b8f1 100644 --- a/tests/docs/base/60_6family_dynamic_inside.adoc +++ b/tests/docs/base/60_6family_dynamic_inside.adoc @@ -7,45 +7,40 @@ var: # a suffix variable - val1 - val2 -'{{ suffix }}_dyn': +'{{ identifier }}_dyn': description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var1: description: value is suffix default: - type: suffix + type: identifier var2: description: value is first variable default: - type: variable - variable: rougail.{{ suffix }}_dyn.var1 + variable: rougail.{{ identifier }}_dyn.var1 var3: description: value is relative first variable default: - type: variable variable: _.var1 var4: description: value is first variable of val1 default: - type: variable variable: rougail.val1_dyn.var1 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -55,50 +50,31 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.val1_dyn.var1** ou **rougail.val2_dyn.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Value is suffix. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. | **rougail.val1_dyn.var2** ou **rougail.val2_dyn.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Value is first variable. + -**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". +**Défaut**: la valeur de la variable "rougail.{{ identifier }}_dyn.var1". | **rougail.val1_dyn.var3** ou **rougail.val2_dyn.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Value is relative first variable. + -**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". +**Défaut**: la valeur de la variable "rougail.{{ identifier }}_dyn.var1". | **rougail.val1_dyn.var4** ou **rougail.val2_dyn.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Value is first variable of val1. + -**Default**: the value of the variable "rougail.val1_dyn.var1". +**Défaut**: la valeur de la variable "rougail.val1_dyn.var1". |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - val1_dyn: - var1: val1 - var2: val1 - var3: val1 - var4: val1 - val2_dyn: - var1: val2 - var2: val2 - var3: val2 - var4: val1 ----- diff --git a/tests/docs/base/60_6family_dynamic_inside.md b/tests/docs/base/60_6family_dynamic_inside.md index 18bb195..131b14a 100644 --- a/tests/docs/base/60_6family_dynamic_inside.md +++ b/tests/docs/base/60_6family_dynamic_inside.md @@ -11,37 +11,32 @@ var: # a suffix variable - val1 - val2 -'{{ suffix }}_dyn': +'{{ identifier }}_dyn': description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var1: description: value is suffix default: - type: suffix + type: identifier var2: description: value is first variable default: - type: variable - variable: rougail.{{ suffix }}_dyn.var1 + variable: rougail.{{ identifier }}_dyn.var1 var3: description: value is relative first variable default: - type: variable variable: _.var1 var4: description: value is first variable of val1 default: - type: variable variable: rougail.val1_dyn.var1 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -50,32 +45,13 @@ var: # a suffix variable This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.val1_dyn.var1** ou **rougail.val2_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: value of the suffix. | -| **rougail.val1_dyn.var2** ou **rougail.val2_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable.
**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". | -| **rougail.val1_dyn.var3** ou **rougail.val2_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is relative first variable.
**Default**: the value of the variable "rougail.{{ suffix }}_dyn.var1". | -| **rougail.val1_dyn.var4** ou **rougail.val2_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is first variable of val1.
**Default**: the value of the variable "rougail.val1_dyn.var1". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.val1_dyn.var1** ou **rougail.val2_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Value is suffix.
**Défaut**: la valeur de identifier. | +| **rougail.val1_dyn.var2** ou **rougail.val2_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Value is first variable.
**Défaut**: la valeur de la variable "rougail.{{ identifier }}_dyn.var1". | +| **rougail.val1_dyn.var3** ou **rougail.val2_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Value is relative first variable.
**Défaut**: la valeur de la variable "rougail.{{ identifier }}_dyn.var1". | +| **rougail.val1_dyn.var4** ou **rougail.val2_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Value is first variable of val1.
**Défaut**: la valeur de la variable "rougail.val1_dyn.var1". | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - val1_dyn: - var1: val1 - var2: val1 - var3: val1 - var4: val1 - val2_dyn: - var1: val2 - var2: val2 - var3: val2 - var4: val1 -``` diff --git a/tests/docs/base/60_6family_dynamic_leadership.adoc b/tests/docs/base/60_6family_dynamic_leadership.adoc index 2d5afad..96dcaa9 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.adoc +++ b/tests/docs/base/60_6family_dynamic_leadership.adoc @@ -6,11 +6,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var leadership: description: a leadership @@ -25,16 +23,16 @@ dyn{{ suffix }}: description: a follower2 mandatory: false ---- -== Variables for "rougail" +== Variables pour "rougail" [cols="96a,96a",options="header"] |==== | Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 * val2 @@ -47,7 +45,7 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". ==== a leadership @@ -61,7 +59,7 @@ This family contains lists of variable blocks. | Variable | Description | **rougail.dynval1.leadership.leader** ou **rougail.dynval2.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | A leader. | **rougail.dynval1.leadership.follower1** ou **rougail.dynval2.leadership.follower1** + @@ -74,22 +72,3 @@ A follower2. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - leadership: - - leader: example - follower1: example - follower2: example - dynval2: - leadership: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/base/60_6family_dynamic_leadership.md b/tests/docs/base/60_6family_dynamic_leadership.md index a3b3029..ca31746 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.md +++ b/tests/docs/base/60_6family_dynamic_leadership.md @@ -10,11 +10,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var leadership: description: a leadership @@ -29,11 +27,11 @@ dyn{{ suffix }}: description: a follower2 mandatory: false ``` -# Variables for "rougail" +# Variables pour "rougail" | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -42,7 +40,7 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". ### a leadership @@ -53,27 +51,8 @@ This family contains lists of variable blocks. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.leadership.leader** ou **rougail.dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dynval1.leadership.leader** ou **rougail.dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | | **rougail.dynval1.leadership.follower1** ou **rougail.dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | | **rougail.dynval1.leadership.follower2** ou **rougail.dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - leadership: - - leader: example - follower1: example - follower2: example - dynval2: - leadership: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc index fe861f8..de9346f 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc @@ -3,68 +3,62 @@ [,yaml] ---- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable multi: true default: - type: jinja jinja: | {% for val in __.var %} t{{ val }} {% endfor %} description: add 't' to each var value - dyn_{{ suffix }}: + dyn_{{ identifier }}: description: a Second dynamic variable - type: dynamic dynamic: - type: variable - variable: rougail.dyn{{ suffix }}.var + variable: rougail.dyn{{ identifier }}.var var: description: A variable dynamic default: - type: suffix - var_suffix: - description: suffix from first family + type: identifier + var_identifier: + description: identifier from first family default: - type: suffix - suffix: 0 - var_suffixes: - description: merge suffixes + type: identifier + identifier: 0 + var_identifiers: + description: merge identifiers default: - type: jinja jinja: | {{ s1 }}-{{ s2 }} params: s1: - type: suffix - suffix: 0 + type: identifier + identifier: 0 s2: - type: suffix - suffix: 1 - description: join suffix 1 et suffix 2 + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A suffix variable. + -**Default**: +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A identifier variable. + +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -74,16 +68,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.var** ou **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A dynamic variable. + -**Default**: add 't' to each var value. +**Défaut**: add 't' to each var value. |==== ==== a Second dynamic variable @@ -93,59 +87,26 @@ A dynamic variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.dyn{{ suffix }}.var". +**Identifiers**: la valeur de la variable "rougail.dyn{{ identifier }}.var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** ou **rougail.dynval2.dyn_tval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable dynamic. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. | -**rougail.dynval1.dyn_tval1.var_suffix**, **rougail.dynval1.dyn_tval2.var_suffix**, **rougail.dynval2.dyn_tval1.var_suffix** ou **rougail.dynval2.dyn_tval2.var_suffix** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -Suffix from first family. + -**Default**: value of the suffix. +**rougail.dynval1.dyn_tval1.var_identifier**, **rougail.dynval1.dyn_tval2.var_identifier**, **rougail.dynval2.dyn_tval1.var_identifier** ou **rougail.dynval2.dyn_tval2.var_identifier** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +Identifier from first family. + +**Défaut**: la valeur de identifier. | -**rougail.dynval1.dyn_tval1.var_suffixes**, **rougail.dynval1.dyn_tval2.var_suffixes**, **rougail.dynval2.dyn_tval1.var_suffixes** ou **rougail.dynval2.dyn_tval2.var_suffixes** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -Merge suffixes. + -**Default**: join suffix 1 et suffix 2. +**rougail.dynval1.dyn_tval1.var_identifiers**, **rougail.dynval1.dyn_tval2.var_identifiers**, **rougail.dynval2.dyn_tval1.var_identifiers** ou **rougail.dynval2.dyn_tval2.var_identifiers** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +Merge identifiers. + +**Défaut**: join identifier 1 et identifier 2. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - val1 - - val2 - dynval1: - var: - - tval1 - - tval2 - dyn_tval1: - var: tval1 - var_suffix: val1 - var_suffixes: val1-tval1 - dyn_tval2: - var: tval2 - var_suffix: val1 - var_suffixes: val1-tval2 - dynval2: - var: - - tval1 - - tval2 - dyn_tval1: - var: tval1 - var_suffix: val2 - var_suffixes: val2-tval1 - dyn_tval2: - var: tval2 - var_suffix: val2 - var_suffixes: val2-tval2 ----- diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.md b/tests/docs/base/60_6family_dynamic_sub_dynamic.md index 719bc4f..2a2440f 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.md +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.md @@ -7,60 +7,54 @@ include_toc: true ```yaml --- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable multi: true default: - type: jinja jinja: | {% for val in __.var %} t{{ val }} {% endfor %} description: add 't' to each var value - dyn_{{ suffix }}: + dyn_{{ identifier }}: description: a Second dynamic variable - type: dynamic dynamic: - type: variable - variable: rougail.dyn{{ suffix }}.var + variable: rougail.dyn{{ identifier }}.var var: description: A variable dynamic default: - type: suffix - var_suffix: - description: suffix from first family + type: identifier + var_identifier: + description: identifier from first family default: - type: suffix - suffix: 0 - var_suffixes: - description: merge suffixes + type: identifier + identifier: 0 + var_identifiers: + description: merge identifiers default: - type: jinja jinja: | {{ s1 }}-{{ s2 }} params: s1: - type: suffix - suffix: 0 + type: identifier + identifier: 0 s2: - type: suffix - suffix: 1 - description: join suffix 1 et suffix 2 + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A identifier variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -69,11 +63,11 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.var** ou **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A dynamic variable.
**Défaut**: add 't' to each var value. | ### a Second dynamic variable @@ -82,45 +76,12 @@ This family builds families dynamically. This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.dyn{{ suffix }}.var". +**Identifiers**: la valeur de la variable "rougail.dyn{{ identifier }}.var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** ou **rougail.dynval2.dyn_tval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: value of the suffix. | -| **rougail.dynval1.dyn_tval1.var_suffix**, **rougail.dynval1.dyn_tval2.var_suffix**, **rougail.dynval2.dyn_tval1.var_suffix** ou **rougail.dynval2.dyn_tval2.var_suffix**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix from first family.
**Default**: value of the suffix. | -| **rougail.dynval1.dyn_tval1.var_suffixes**, **rougail.dynval1.dyn_tval2.var_suffixes**, **rougail.dynval2.dyn_tval1.var_suffixes** ou **rougail.dynval2.dyn_tval2.var_suffixes**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge suffixes.
**Default**: join suffix 1 et suffix 2. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.dyn_tval1.var**, **rougail.dynval1.dyn_tval2.var**, **rougail.dynval2.dyn_tval1.var** ou **rougail.dynval2.dyn_tval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable dynamic.
**Défaut**: la valeur de identifier. | +| **rougail.dynval1.dyn_tval1.var_identifier**, **rougail.dynval1.dyn_tval2.var_identifier**, **rougail.dynval2.dyn_tval1.var_identifier** ou **rougail.dynval2.dyn_tval2.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Identifier from first family.
**Défaut**: la valeur de identifier. | +| **rougail.dynval1.dyn_tval1.var_identifiers**, **rougail.dynval1.dyn_tval2.var_identifiers**, **rougail.dynval2.dyn_tval1.var_identifiers** ou **rougail.dynval2.dyn_tval2.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Merge identifiers.
**Défaut**: join identifier 1 et identifier 2. | -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - val1 - - val2 - dynval1: - var: - - tval1 - - tval2 - dyn_tval1: - var: tval1 - var_suffix: val1 - var_suffixes: val1-tval1 - dyn_tval2: - var: tval2 - var_suffix: val1 - var_suffixes: val1-tval2 - dynval2: - var: - - tval1 - - tval2 - dyn_tval1: - var: tval1 - var_suffix: val2 - var_suffixes: val2-tval1 - dyn_tval2: - var: tval2 - var_suffix: val2 - var_suffixes: val2-tval2 -``` diff --git a/tests/docs/base/60_9extra_dynamic.adoc b/tests/docs/base/60_9extra_dynamic.adoc index cbd47f1..e560936 100644 --- a/tests/docs/base/60_9extra_dynamic.adoc +++ b/tests/docs/base/60_9extra_dynamic.adoc @@ -11,29 +11,27 @@ var: # a variable [,yaml] ---- version: 1.1 -dyn_{{ suffix }}: - type: dynamic +dyn_{{ identifier }}: dynamic: - type: variable variable: rougail.var var: ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* a +* a |==== -== Variables for "extra" +== Variables pour "extra" === "dyn__a_" @@ -42,34 +40,15 @@ A variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **extra.dyn_a.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Var. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -extra: - dyn_a: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: - - a -extra: - dyn_a: - var: example ----- diff --git a/tests/docs/base/60_9extra_dynamic.md b/tests/docs/base/60_9extra_dynamic.md index 45f9b35..b80b649 100644 --- a/tests/docs/base/60_9extra_dynamic.md +++ b/tests/docs/base/60_9extra_dynamic.md @@ -15,21 +15,19 @@ var: # a variable ```yaml --- version: 1.1 -dyn_{{ suffix }}: - type: dynamic +dyn_{{ identifier }}: dynamic: - type: variable variable: rougail.var var: ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- a | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- a | -# Variables for "extra" +# Variables pour "extra" ## "dyn_*a*" @@ -38,29 +36,10 @@ dyn_{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "rougail.var". +**Identifiers**: la valeur de la variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Var. | -# Example with mandatory variables not filled in - -```yaml ---- -extra: - dyn_a: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: - - a -extra: - dyn_a: - var: example -``` diff --git a/tests/docs/base/60_9extra_dynamic_extra.adoc b/tests/docs/base/60_9extra_dynamic_extra.adoc index e4be9b3..ad006b2 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.adoc +++ b/tests/docs/base/60_9extra_dynamic_extra.adoc @@ -19,44 +19,42 @@ version: '1.0' version: '1.1' var: # a varaible - a -dyn_{{ suffix }}: - type: dynamic +dyn_{{ identifier }}: dynamic: - type: variable variable: _.var var: ---- -== Variables for "rougail" +== Variables pour "rougail" === général `standard` -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.general.varname** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | No change. + -**Default**: +**Défaut**: -* a +* a |==== -== Variables for "extra" +== Variables pour "extra" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **extra.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A varaible. + -**Default**: +**Défaut**: -* a +* a |==== === "dyn__a_" @@ -66,37 +64,15 @@ A varaible. + This family builds families dynamically. -**Suffixes**: the value of the variable "extra.var". +**Identifiers**: la valeur de la variable "extra.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **extra.dyn_a.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Var. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -extra: - dyn_a: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - general: - varname: - - a -extra: - var: - - a - dyn_a: - var: example ----- diff --git a/tests/docs/base/60_9extra_dynamic_extra.md b/tests/docs/base/60_9extra_dynamic_extra.md index 51db57b..1eb94ce 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.md +++ b/tests/docs/base/60_9extra_dynamic_extra.md @@ -23,29 +23,27 @@ version: '1.0' version: '1.1' var: # a varaible - a -dyn_{{ suffix }}: - type: dynamic +dyn_{{ identifier }}: dynamic: - type: variable variable: _.var var: ``` -# Variables for "rougail" +# Variables pour "rougail" ## général `standard` -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.general.varname**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | No change.
**Default**:
- a | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.varname**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | No change.
**Défaut**:
- a | -# Variables for "extra" +# Variables pour "extra" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A varaible.
**Default**:
- a | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A varaible.
**Défaut**:
- a | ## "dyn_*a*" @@ -54,32 +52,10 @@ dyn_{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "extra.var". +**Identifiers**: la valeur de la variable "extra.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_a.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Var. | -# Example with mandatory variables not filled in - -```yaml ---- -extra: - dyn_a: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - general: - varname: - - a -extra: - var: - - a - dyn_a: - var: example -``` diff --git a/tests/docs/base/60_9family_dynamic_calc_both.adoc b/tests/docs/base/60_9family_dynamic_calc_both.adoc index eaab794..79628a1 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/base/60_9family_dynamic_calc_both.adoc @@ -4,25 +4,23 @@ ---- version: '1.1' var: val2 # a suffix variable -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: description: a dynamic family dynamic: - val1 - - type: variable - variable: _.var + - variable: _.var vardyn: # a dynamic variable ---- -== Variables for "rougail" +== Variables pour "rougail" -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A suffix variable. + -**Default**: val2 +**Défaut**: val2 |==== === a dynamic family @@ -32,39 +30,18 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 -* the value of the variable "rougail.var". +* la valeur de la variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - var: val2 - dynval1: - vardyn: example - dynval2: - vardyn: example ----- diff --git a/tests/docs/base/60_9family_dynamic_calc_both.md b/tests/docs/base/60_9family_dynamic_calc_both.md index d072aa1..72a6e8c 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.md +++ b/tests/docs/base/60_9family_dynamic_calc_both.md @@ -8,20 +8,18 @@ include_toc: true --- version: '1.1' var: val2 # a suffix variable -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: description: a dynamic family dynamic: - val1 - - type: variable - variable: _.var + - variable: _.var vardyn: # a dynamic variable ``` -# Variables for "rougail" +# Variables pour "rougail" -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A suffix variable.
**Défaut**: val2 | ## a dynamic family @@ -30,31 +28,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**:
- val1
- the value of the variable "rougail.var". +**Identifiers**:
- val1
- la valeur de la variable "rougail.var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dynval1.vardyn** ou **rougail.dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - dynval1: - vardyn: example - dynval2: - vardyn: example -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - var: val2 - dynval1: - vardyn: example - dynval2: - vardyn: example -``` diff --git a/tests/docs/base/68_0family_leadership_mode.adoc b/tests/docs/base/68_0family_leadership_mode.adoc index f266948..198fd77 100644 --- a/tests/docs/base/68_0family_leadership_mode.adoc +++ b/tests/docs/base/68_0family_leadership_mode.adoc @@ -17,7 +17,7 @@ leader: description: a follower2 mode: basic ---- -== Variables for "rougail" +== Variables pour "rougail" === A leadership @@ -26,31 +26,21 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **rougail.leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | +A leader. | **rougail.leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | **rougail.leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower2. |==== -== Example with all variables modifiable - -[,yaml] ----- -rougail: - leader: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/base/68_0family_leadership_mode.md b/tests/docs/base/68_0family_leadership_mode.md index 8f21d1e..f768c4c 100644 --- a/tests/docs/base/68_0family_leadership_mode.md +++ b/tests/docs/base/68_0family_leadership_mode.md @@ -21,7 +21,7 @@ leader: description: a follower2 mode: basic ``` -# Variables for "rougail" +# Variables pour "rougail" ## A leadership @@ -30,20 +30,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | -| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower2. | -# Example with all variables modifiable - -```yaml ---- -rougail: - leader: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/no_namespace/00_0version_underscore.adoc b/tests/docs/no_namespace/00_0version_underscore.adoc index 09e6aab..4257948 100644 --- a/tests/docs/no_namespace/00_0version_underscore.adoc +++ b/tests/docs/no_namespace/00_0version_underscore.adoc @@ -7,25 +7,13 @@ version: # a variable ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **version** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -version: example ----- -== Example with all variables modifiable - -[,yaml] ----- -version: example ----- diff --git a/tests/docs/no_namespace/00_0version_underscore.md b/tests/docs/no_namespace/00_0version_underscore.md index 2709ed2..2239d8f 100644 --- a/tests/docs/no_namespace/00_0version_underscore.md +++ b/tests/docs/no_namespace/00_0version_underscore.md @@ -11,20 +11,8 @@ version: # a variable ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -version: example -``` -# Example with all variables modifiable - -```yaml ---- -version: example -``` diff --git a/tests/docs/no_namespace/00_1empty_variable.adoc b/tests/docs/no_namespace/00_1empty_variable.adoc index 7dd7fda..3bd4efb 100644 --- a/tests/docs/no_namespace/00_1empty_variable.adoc +++ b/tests/docs/no_namespace/00_1empty_variable.adoc @@ -7,25 +7,13 @@ empty: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **empty** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Empty. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Empty. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -empty: example ----- -== Example with all variables modifiable - -[,yaml] ----- -empty: example ----- diff --git a/tests/docs/no_namespace/00_1empty_variable.md b/tests/docs/no_namespace/00_1empty_variable.md index 10e4000..1f43d65 100644 --- a/tests/docs/no_namespace/00_1empty_variable.md +++ b/tests/docs/no_namespace/00_1empty_variable.md @@ -11,20 +11,8 @@ empty: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Empty. | -# Example with mandatory variables not filled in - -```yaml ---- -empty: example -``` -# Example with all variables modifiable - -```yaml ---- -empty: example -``` diff --git a/tests/docs/no_namespace/00_2default_calculated.adoc b/tests/docs/no_namespace/00_2default_calculated.adoc index 959e5fc..68ecdb5 100644 --- a/tests/docs/no_namespace/00_2default_calculated.adoc +++ b/tests/docs/no_namespace/00_2default_calculated.adoc @@ -8,34 +8,25 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {{ _.var1 }} description: the value of var1 ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: the value of var1. +**Défaut**: the value of var1. |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: - - no ----- diff --git a/tests/docs/no_namespace/00_2default_calculated.md b/tests/docs/no_namespace/00_2default_calculated.md index 4b64b24..a29908f 100644 --- a/tests/docs/no_namespace/00_2default_calculated.md +++ b/tests/docs/no_namespace/00_2default_calculated.md @@ -12,24 +12,15 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {{ _.var1 }} description: the value of var1 ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of var1. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**: the value of var1. | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: - - no -``` diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.adoc b/tests/docs/no_namespace/00_2default_calculated_multi.adoc index dff3ac3..e8194c0 100644 --- a/tests/docs/no_namespace/00_2default_calculated_multi.adoc +++ b/tests/docs/no_namespace/00_2default_calculated_multi.adoc @@ -11,7 +11,6 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {% for val in _.var1 %} {{ val }} @@ -20,36 +19,23 @@ var2: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: * no * yes -* maybe +* maybe | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: the value of _.var1. +**Défaut**: the value of _.var1. |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - no - - yes - - maybe -var2: - - no - - yes - - maybe ----- diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.md b/tests/docs/no_namespace/00_2default_calculated_multi.md index 4330622..91538e9 100644 --- a/tests/docs/no_namespace/00_2default_calculated_multi.md +++ b/tests/docs/no_namespace/00_2default_calculated_multi.md @@ -15,7 +15,6 @@ var2: description: a second variable multi: true default: - type: jinja jinja: | {% for val in _.var1 %} {{ val }} @@ -24,22 +23,9 @@ var2: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- no
- yes
- maybe | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**: the value of _.var1. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- no
- yes
- maybe | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**: the value of _.var1. | -# Example with all variables modifiable - -```yaml ---- -var1: - - no - - yes - - maybe -var2: - - no - - yes - - maybe -``` diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc new file mode 100644 index 0000000..1a63ad9 --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc @@ -0,0 +1,38 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +---- +== Variables + +[cols="134a,134a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `obligatoire` `unique` `multiple` | +A first variable. + +**Validator**: le nom de domaine peut être une IP +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: le nom de domaine peut être une IP + +**Défaut**: la valeur de la variable "var1". +|==== + + diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..31f3a8c --- /dev/null +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + multi: true + type: domainname + params: + allow_ip: true + +var2: + description: a second variable + default: + type: variable + variable: _.var1 +``` +# Variables + +| Variable                                                                                                                             | Description                                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first variable.
**Validator**: le nom de domaine peut être une IP | +| **var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: le nom de domaine peut être une IP
**Défaut**: la valeur de la variable "var1". | + + diff --git a/tests/docs/no_namespace/00_4load_subfolder.adoc b/tests/docs/no_namespace/00_4load_subfolder.adoc index 8020d91..ca2eb31 100644 --- a/tests/docs/no_namespace/00_4load_subfolder.adoc +++ b/tests/docs/no_namespace/00_4load_subfolder.adoc @@ -16,31 +16,17 @@ var2: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: example -var2: example ----- diff --git a/tests/docs/no_namespace/00_4load_subfolder.md b/tests/docs/no_namespace/00_4load_subfolder.md index 82f8b19..0a8ec79 100644 --- a/tests/docs/no_namespace/00_4load_subfolder.md +++ b/tests/docs/no_namespace/00_4load_subfolder.md @@ -20,23 +20,9 @@ var2: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: example -var2: example -``` diff --git a/tests/docs/no_namespace/00_5load_notype.adoc b/tests/docs/no_namespace/00_5load_notype.adoc index 8cec498..e9e948d 100644 --- a/tests/docs/no_namespace/00_5load_notype.adoc +++ b/tests/docs/no_namespace/00_5load_notype.adoc @@ -9,20 +9,14 @@ without_type: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **without_type** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: non +**Défaut**: non |==== -== Example with all variables modifiable - -[,yaml] ----- -without_type: non ----- diff --git a/tests/docs/no_namespace/00_5load_notype.md b/tests/docs/no_namespace/00_5load_notype.md index a199070..f57f882 100644 --- a/tests/docs/no_namespace/00_5load_notype.md +++ b/tests/docs/no_namespace/00_5load_notype.md @@ -13,14 +13,8 @@ without_type: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: non | -# Example with all variables modifiable - -```yaml ---- -without_type: non -``` diff --git a/tests/docs/no_namespace/00_6boolean.adoc b/tests/docs/no_namespace/00_6boolean.adoc index 5291154..803f863 100644 --- a/tests/docs/no_namespace/00_6boolean.adoc +++ b/tests/docs/no_namespace/00_6boolean.adoc @@ -22,50 +22,39 @@ var6: ---- == Variables -[cols="109a,109a",options="header"] +[cols="111a,111a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The first variable. + -**Default**: True +**Défaut**: True | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The second variable. + -**Default**: True +**Défaut**: True | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The third variable. + -**Default**: True +**Défaut**: True | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The forth variable. + -**Default**: False +**Défaut**: False | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The fifth variable. + -**Default**: False +**Défaut**: False | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The sixth variable. + -**Default**: False +**Défaut**: False |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: true -var2: true -var3: true -var4: false -var5: false -var6: false ----- diff --git a/tests/docs/no_namespace/00_6boolean.md b/tests/docs/no_namespace/00_6boolean.md index efabf1a..3aef055 100644 --- a/tests/docs/no_namespace/00_6boolean.md +++ b/tests/docs/no_namespace/00_6boolean.md @@ -26,24 +26,13 @@ var6: ``` # Variables -| Variable                                                                                                    | Description                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: True | -| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: True | -| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: True | -| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: False | -| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: False | -| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: False | +| Variable                                                                                                      | Description                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: True | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: True | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: True | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: False | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: False | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: False | -# Example with all variables modifiable - -```yaml ---- -var1: true -var2: true -var3: true -var4: false -var5: false -var6: false -``` diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc index 640da04..6136daf 100644 --- a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc @@ -17,13 +17,7 @@ variable: **variable** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | A variable. + -**Default**: True +**Défaut**: True |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: true ----- diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.md b/tests/docs/no_namespace/00_6boolean_no_mandatory.md index 39398f6..7c9b7ba 100644 --- a/tests/docs/no_namespace/00_6boolean_no_mandatory.md +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.md @@ -16,12 +16,6 @@ variable: | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: True | +| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Défaut**: True | -# Example with all variables modifiable - -```yaml ---- -variable: true -``` diff --git a/tests/docs/no_namespace/00_6choice.adoc b/tests/docs/no_namespace/00_6choice.adoc index c2870c8..3e15d4e 100644 --- a/tests/docs/no_namespace/00_6choice.adoc +++ b/tests/docs/no_namespace/00_6choice.adoc @@ -46,82 +46,64 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | The first variable. + -**Choices**: +**Choix**: * a * b -* c +* c | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | The second variable. + -**Choices**: +**Choix**: * a * b -* c +* c | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The third variable. + -**Choices**: +**Choix**: * a * b * c -* null +* null | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | The forth variable. + -**Choices**: +**Choix**: * null * b -* c +* c | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | The fifth variable. + -**Choices**: +**Choix**: -* a ← (default) +* a ← (defaut) * b -* c +* c | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | The sixth variable. + -**Choices**: +**Choix**: -* 1 ← (default) +* 1 ← (defaut) * 2 -* 3 +* 3 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: a_choice -var2: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: a_choice -var2: a_choice -var3: a_choice -var4: a_choice -var5: a -var6: 1 ----- diff --git a/tests/docs/no_namespace/00_6choice.md b/tests/docs/no_namespace/00_6choice.md index ce34e3a..578cd5f 100644 --- a/tests/docs/no_namespace/00_6choice.md +++ b/tests/docs/no_namespace/00_6choice.md @@ -50,31 +50,13 @@ var6: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Choices**:
- a
- b
- c | -| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
**Choices**:
- a
- b
- c | -| **var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choices**:
- a
- b
- c
- null | -| **var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choices**:
- null
- b
- c | -| **var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Choices**:
- a ← (default)
- b
- c | -| **var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Choices**:
- 1 ← (default)
- 2
- 3 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
**Choix**:
- a
- b
- c | +| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable.
**Choix**:
- a
- b
- c | +| **var3**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The third variable.
**Choix**:
- a
- b
- c
- null | +| **var4**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Choix**:
- null
- b
- c | +| **var5**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Choix**:
- a ← (defaut)
- b
- c | +| **var6**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Choix**:
- 1 ← (defaut)
- 2
- 3 | -# Example with mandatory variables not filled in - -```yaml ---- -var1: a_choice -var2: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -var1: a_choice -var2: a_choice -var3: a_choice -var4: a_choice -var5: a -var6: 1 -``` diff --git a/tests/docs/no_namespace/00_6choice_calculation.adoc b/tests/docs/no_namespace/00_6choice_calculation.adoc index 8b21d80..253bb74 100644 --- a/tests/docs/no_namespace/00_6choice_calculation.adoc +++ b/tests/docs/no_namespace/00_6choice_calculation.adoc @@ -7,7 +7,6 @@ var: description: a variable default: 9 choices: - type: jinja jinja: | {% for n in trange(0, 10) %} {{ n }} @@ -17,21 +16,15 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A variable. + -**Choices**: choices is 0 to 9. + -**Default**: 9 +**Choix**: choices is 0 to 9. + +**Défaut**: 9 |==== -== Example with all variables modifiable - -[,yaml] ----- -var: 9 ----- diff --git a/tests/docs/no_namespace/00_6choice_calculation.md b/tests/docs/no_namespace/00_6choice_calculation.md index 57b49ca..db1f934 100644 --- a/tests/docs/no_namespace/00_6choice_calculation.md +++ b/tests/docs/no_namespace/00_6choice_calculation.md @@ -11,7 +11,6 @@ var: description: a variable default: 9 choices: - type: jinja jinja: | {% for n in trange(0, 10) %} {{ n }} @@ -21,14 +20,8 @@ var: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**: choices is 0 to 9.
**Défaut**: 9 | -# Example with all variables modifiable - -```yaml ---- -var: 9 -``` diff --git a/tests/docs/no_namespace/00_6choice_variable.adoc b/tests/docs/no_namespace/00_6choice_variable.adoc index 3cab334..164a13b 100644 --- a/tests/docs/no_namespace/00_6choice_variable.adoc +++ b/tests/docs/no_namespace/00_6choice_variable.adoc @@ -11,39 +11,28 @@ var2: description: a first variable default: a choices: - type: variable variable: _.var1 ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A second variable. + -**Default**: +**Défaut**: * a * b -* c +* c | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A first variable. + -**Choices**: the value of the variable "var1". + -**Default**: a +**Choix**: la valeur de la variable "var1". + +**Défaut**: a |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - a - - b - - c -var2: a ----- diff --git a/tests/docs/no_namespace/00_6choice_variable.md b/tests/docs/no_namespace/00_6choice_variable.md index 42a0ced..fb13c63 100644 --- a/tests/docs/no_namespace/00_6choice_variable.md +++ b/tests/docs/no_namespace/00_6choice_variable.md @@ -15,24 +15,13 @@ var2: description: a first variable default: a choices: - type: variable variable: _.var1 ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Default**:
- a
- b
- c | -| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Choices**: the value of the variable "var1".
**Default**: a | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Défaut**:
- a
- b
- c | +| **var2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Choix**: la valeur de la variable "var1".
**Défaut**: a | -# Example with all variables modifiable - -```yaml ---- -var1: - - a - - b - - c -var2: a -``` diff --git a/tests/docs/no_namespace/00_6custom.adoc b/tests/docs/no_namespace/00_6custom.adoc index 729718a..5e99c84 100644 --- a/tests/docs/no_namespace/00_6custom.adoc +++ b/tests/docs/no_namespace/00_6custom.adoc @@ -13,31 +13,18 @@ custom2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `obligatoire` | +The first variable. | **custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `obligatoire` | The seconf variable. + -**Default**: value +**Défaut**: value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -custom1: xxx ----- -== Example with all variables modifiable - -[,yaml] ----- -custom1: xxx -custom2: value ----- diff --git a/tests/docs/no_namespace/00_6custom.md b/tests/docs/no_namespace/00_6custom.md index 28456f3..ab0bd39 100644 --- a/tests/docs/no_namespace/00_6custom.md +++ b/tests/docs/no_namespace/00_6custom.md @@ -17,22 +17,9 @@ custom2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The seconf variable.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The seconf variable.
**Défaut**: value | -# Example with mandatory variables not filled in - -```yaml ---- -custom1: xxx -``` -# Example with all variables modifiable - -```yaml ---- -custom1: xxx -custom2: value -``` diff --git a/tests/docs/no_namespace/00_6domainname.adoc b/tests/docs/no_namespace/00_6domainname.adoc index 2c49acd..4ff8bc1 100644 --- a/tests/docs/no_namespace/00_6domainname.adoc +++ b/tests/docs/no_namespace/00_6domainname.adoc @@ -10,20 +10,14 @@ variable: ---- == Variables -[cols="112a,112a",options="header"] +[cols="114a,114a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` | A domain name variable. + -**Default**: my.domain.name +**Défaut**: my.domain.name |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: my.domain.name ----- diff --git a/tests/docs/no_namespace/00_6domainname.md b/tests/docs/no_namespace/00_6domainname.md index 3b6ce01..04625c7 100644 --- a/tests/docs/no_namespace/00_6domainname.md +++ b/tests/docs/no_namespace/00_6domainname.md @@ -14,14 +14,8 @@ variable: ``` # Variables -| Variable                                                                                                       | Description                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: my.domain.name | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A domain name variable.
**Défaut**: my.domain.name | -# Example with all variables modifiable - -```yaml ---- -variable: my.domain.name -``` diff --git a/tests/docs/no_namespace/00_6domainname_params.adoc b/tests/docs/no_namespace/00_6domainname_params.adoc index e8df208..f1b6aac 100644 --- a/tests/docs/no_namespace/00_6domainname_params.adoc +++ b/tests/docs/no_namespace/00_6domainname_params.adoc @@ -12,21 +12,15 @@ variable: ---- == Variables -[cols="112a,112a",options="header"] +[cols="114a,114a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `obligatoire` | A domain name variable. + -**Validator**: the domain name can be an IP + -**Default**: my.domain.name +**Validator**: le nom de domaine peut être une IP + +**Défaut**: my.domain.name |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: my.domain.name ----- diff --git a/tests/docs/no_namespace/00_6domainname_params.md b/tests/docs/no_namespace/00_6domainname_params.md index 3d7d094..1d598ab 100644 --- a/tests/docs/no_namespace/00_6domainname_params.md +++ b/tests/docs/no_namespace/00_6domainname_params.md @@ -16,14 +16,8 @@ variable: ``` # Variables -| Variable                                                                                                       | Description                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Validator**: the domain name can be an IP
**Default**: my.domain.name | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A domain name variable.
**Validator**: le nom de domaine peut être une IP
**Défaut**: my.domain.name | -# Example with all variables modifiable - -```yaml ---- -variable: my.domain.name -``` diff --git a/tests/docs/no_namespace/00_6float.adoc b/tests/docs/no_namespace/00_6float.adoc index b388eca..161890f 100644 --- a/tests/docs/no_namespace/00_6float.adoc +++ b/tests/docs/no_namespace/00_6float.adoc @@ -22,50 +22,39 @@ var6: ---- == Variables -[cols="107a,107a",options="header"] +[cols="109a,109a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The first variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The second variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The third variable. + -**Default**: 0.0 +**Défaut**: 0.0 | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The forth variable. + -**Default**: 10.1 +**Défaut**: 10.1 | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The fifth variable. + -**Default**: 10.1 +**Défaut**: 10.1 | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` | The sixth variable. + -**Default**: 10.1 +**Défaut**: 10.1 |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: 0.0 -var2: 0.0 -var3: 0.0 -var4: 10.1 -var5: 10.1 -var6: 10.1 ----- diff --git a/tests/docs/no_namespace/00_6float.md b/tests/docs/no_namespace/00_6float.md index 4db028e..9f41e83 100644 --- a/tests/docs/no_namespace/00_6float.md +++ b/tests/docs/no_namespace/00_6float.md @@ -26,24 +26,13 @@ var6: ``` # Variables -| Variable                                                                                                  | Description                                                                                               | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0.0 | -| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0.0 | -| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0.0 | -| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: 10.1 | -| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10.1 | -| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10.1 | +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: 0.0 | +| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: 0.0 | +| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: 0.0 | +| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: 10.1 | +| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: 10.1 | +| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: 10.1 | -# Example with all variables modifiable - -```yaml ---- -var1: 0.0 -var2: 0.0 -var3: 0.0 -var4: 10.1 -var5: 10.1 -var6: 10.1 -``` diff --git a/tests/docs/no_namespace/00_6number.adoc b/tests/docs/no_namespace/00_6number.adoc index 54b0fd5..5acc164 100644 --- a/tests/docs/no_namespace/00_6number.adoc +++ b/tests/docs/no_namespace/00_6number.adoc @@ -22,50 +22,39 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The first variable. + -**Default**: 0 +**Défaut**: 0 | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The second variable. + -**Default**: 0 +**Défaut**: 0 | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The third variable. + -**Default**: 0 +**Défaut**: 0 | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | This forth variable. + -**Default**: 10 +**Défaut**: 10 | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The fifth variable. + -**Default**: 10 +**Défaut**: 10 | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | The sixth variable. + -**Default**: 10 +**Défaut**: 10 |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: 0 -var2: 0 -var3: 0 -var4: 10 -var5: 10 -var6: 10 ----- diff --git a/tests/docs/no_namespace/00_6number.md b/tests/docs/no_namespace/00_6number.md index c218d39..c0d208f 100644 --- a/tests/docs/no_namespace/00_6number.md +++ b/tests/docs/no_namespace/00_6number.md @@ -26,24 +26,13 @@ var6: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first variable.
**Default**: 0 | -| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: 0 | -| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The third variable.
**Default**: 0 | -| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | This forth variable.
**Default**: 10 | -| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: 10 | -| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: 10 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first variable.
**Défaut**: 0 | +| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: 0 | +| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The third variable.
**Défaut**: 0 | +| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | This forth variable.
**Défaut**: 10 | +| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: 10 | +| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: 10 | -# Example with all variables modifiable - -```yaml ---- -var1: 0 -var2: 0 -var3: 0 -var4: 10 -var5: 10 -var6: 10 -``` diff --git a/tests/docs/no_namespace/00_6port.adoc b/tests/docs/no_namespace/00_6port.adoc new file mode 100644 index 0000000..6c06023 --- /dev/null +++ b/tests/docs/no_namespace/00_6port.adoc @@ -0,0 +1,39 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +---- +== Variables + +[cols="108a,108a",options="header"] +|==== +| Variable | Description +| +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `obligatoire` | +A port variable. +| +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `obligatoire` | +A port variable with default value. + +**Défaut**: 8080 +| +**variable3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `obligatoire` | +A port variable with integer default value. + +**Défaut**: 8080 +|==== + + diff --git a/tests/docs/no_namespace/00_6port.md b/tests/docs/no_namespace/00_6port.md new file mode 100644 index 0000000..25ad73e --- /dev/null +++ b/tests/docs/no_namespace/00_6port.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +variable1: + description: a port variable + type: port +variable2: + description: a port variable with default value + type: port + default: '8080' +variable3: + description: a port variable with integer default value + type: port + default: 8080 +``` +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A port variable. | +| **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A port variable with default value.
**Défaut**: 8080 | +| **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A port variable with integer default value.
**Défaut**: 8080 | + + diff --git a/tests/docs/no_namespace/00_6regexp.adoc b/tests/docs/no_namespace/00_6regexp.adoc new file mode 100644 index 0000000..0f0f937 --- /dev/null +++ b/tests/docs/no_namespace/00_6regexp.adoc @@ -0,0 +1,27 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `obligatoire` | +A first variable. + +**Défaut**: #a1a1a1 + +**Exemple**: #b1b1b1 +|==== + + diff --git a/tests/docs/no_namespace/00_6regexp.md b/tests/docs/no_namespace/00_6regexp.md new file mode 100644 index 0000000..16c7414 --- /dev/null +++ b/tests/docs/no_namespace/00_6regexp.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a first variable + regexp: ^#(?:[0-9a-f]{3}){1,2}$ + default: '#a1a1a1' + test: + - '#b1b1b1' + - '#b2b2b2' +``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: #a1a1a1
**Exemple**: #b1b1b1 | + + diff --git a/tests/docs/no_namespace/00_6string.adoc b/tests/docs/no_namespace/00_6string.adoc index 9e57039..4e93e01 100644 --- a/tests/docs/no_namespace/00_6string.adoc +++ b/tests/docs/no_namespace/00_6string.adoc @@ -21,55 +21,36 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The first variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The second variable. | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The third variable. | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The forth variable. + -**Default**: value +**Défaut**: value | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The fifth variable. + -**Default**: value +**Défaut**: value | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The sixth variable. + -**Default**: value +**Défaut**: value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example -var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: example -var2: example -var3: example -var4: value -var5: value -var6: value ----- diff --git a/tests/docs/no_namespace/00_6string.md b/tests/docs/no_namespace/00_6string.md index 6bcf0ac..1c546b4 100644 --- a/tests/docs/no_namespace/00_6string.md +++ b/tests/docs/no_namespace/00_6string.md @@ -25,32 +25,13 @@ var6: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The forth variable.
**Default**: value | -| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: value | -| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The sixth variable.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable. | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The forth variable.
**Défaut**: value | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: value | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The sixth variable.
**Défaut**: value | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -var3: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: example -var2: example -var3: example -var4: value -var5: value -var6: value -``` diff --git a/tests/docs/no_namespace/00_7choice_quote.adoc b/tests/docs/no_namespace/00_7choice_quote.adoc index fe03b97..64c7934 100644 --- a/tests/docs/no_namespace/00_7choice_quote.adoc +++ b/tests/docs/no_namespace/00_7choice_quote.adoc @@ -14,24 +14,18 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A choice. + -**Choices**: +**Choix**: -* quote' ← (default) +* quote' ← (defaut) * quote" -* quote"' +* quote"' |==== -== Example with all variables modifiable - -[,yaml] ----- -var: quote' ----- diff --git a/tests/docs/no_namespace/00_7choice_quote.md b/tests/docs/no_namespace/00_7choice_quote.md index aadd30c..07cd993 100644 --- a/tests/docs/no_namespace/00_7choice_quote.md +++ b/tests/docs/no_namespace/00_7choice_quote.md @@ -18,14 +18,8 @@ var: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A choice.
**Choix**:
- quote' ← (defaut)
- quote"
- quote"' | -# Example with all variables modifiable - -```yaml ---- -var: quote' -``` diff --git a/tests/docs/no_namespace/00_7help_quote.adoc b/tests/docs/no_namespace/00_7help_quote.adoc index f6498da..d7723aa 100644 --- a/tests/docs/no_namespace/00_7help_quote.adoc +++ b/tests/docs/no_namespace/00_7help_quote.adoc @@ -12,33 +12,19 @@ var2: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The first variable. + -Message with '. +Message with '. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The second variable. + -Message with ". +Message with ". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: example -var2: example ----- diff --git a/tests/docs/no_namespace/00_7help_quote.md b/tests/docs/no_namespace/00_7help_quote.md index c0b3cd8..428cc18 100644 --- a/tests/docs/no_namespace/00_7help_quote.md +++ b/tests/docs/no_namespace/00_7help_quote.md @@ -16,23 +16,9 @@ var2: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Message with '. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Message with ". | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
Message with '. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable.
Message with ". | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: example -var2: example -``` diff --git a/tests/docs/no_namespace/00_7value_doublequote.adoc b/tests/docs/no_namespace/00_7value_doublequote.adoc index 887e513..3bcd5fd 100644 --- a/tests/docs/no_namespace/00_7value_doublequote.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote.adoc @@ -9,20 +9,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote" +**Défaut**: quote" |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: quote" ----- diff --git a/tests/docs/no_namespace/00_7value_doublequote.md b/tests/docs/no_namespace/00_7value_doublequote.md index c946bdd..f8afccd 100644 --- a/tests/docs/no_namespace/00_7value_doublequote.md +++ b/tests/docs/no_namespace/00_7value_doublequote.md @@ -13,14 +13,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote" | -# Example with all variables modifiable - -```yaml ---- -variable: quote" -``` diff --git a/tests/docs/no_namespace/00_7value_doublequote2.adoc b/tests/docs/no_namespace/00_7value_doublequote2.adoc index 86dfaf8..9b66f55 100644 --- a/tests/docs/no_namespace/00_7value_doublequote2.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote2.adoc @@ -9,20 +9,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote'" +**Défaut**: quote'" |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: quote'" ----- diff --git a/tests/docs/no_namespace/00_7value_doublequote2.md b/tests/docs/no_namespace/00_7value_doublequote2.md index c89bb92..8a9d6ba 100644 --- a/tests/docs/no_namespace/00_7value_doublequote2.md +++ b/tests/docs/no_namespace/00_7value_doublequote2.md @@ -13,14 +13,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote'" | -# Example with all variables modifiable - -```yaml ---- -variable: quote'" -``` diff --git a/tests/docs/no_namespace/00_7value_doublequote3.adoc b/tests/docs/no_namespace/00_7value_doublequote3.adoc index dcee9ff..e081438 100644 --- a/tests/docs/no_namespace/00_7value_doublequote3.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote3.adoc @@ -2,9 +2,22 @@ [,yaml] ---- -version: '1.0' +version: '1.1' + variable: description: a variable - hidden: true default: quote\"\' ---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A variable. + +**Défaut**: quote\"\' +|==== + + diff --git a/tests/docs/no_namespace/00_7value_doublequote3.md b/tests/docs/no_namespace/00_7value_doublequote3.md index 391ed13..b1cb0bf 100644 --- a/tests/docs/no_namespace/00_7value_doublequote3.md +++ b/tests/docs/no_namespace/00_7value_doublequote3.md @@ -6,9 +6,16 @@ include_toc: true ```yaml --- -version: '1.0' +version: '1.1' + variable: description: a variable - hidden: true default: quote\"\' ``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote\"\' | + + diff --git a/tests/docs/no_namespace/00_7value_quote.adoc b/tests/docs/no_namespace/00_7value_quote.adoc index f3848ec..fd34244 100644 --- a/tests/docs/no_namespace/00_7value_quote.adoc +++ b/tests/docs/no_namespace/00_7value_quote.adoc @@ -9,20 +9,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: quote' +**Défaut**: quote' |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: quote' ----- diff --git a/tests/docs/no_namespace/00_7value_quote.md b/tests/docs/no_namespace/00_7value_quote.md index bbcba9b..a0e256a 100644 --- a/tests/docs/no_namespace/00_7value_quote.md +++ b/tests/docs/no_namespace/00_7value_quote.md @@ -13,14 +13,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: quote' | -# Example with all variables modifiable - -```yaml ---- -variable: quote' -``` diff --git a/tests/docs/no_namespace/00_8calculation_information.adoc b/tests/docs/no_namespace/00_8calculation_information.adoc index 8fa01d9..7f4d4c3 100644 --- a/tests/docs/no_namespace/00_8calculation_information.adoc +++ b/tests/docs/no_namespace/00_8calculation_information.adoc @@ -6,7 +6,6 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: | {{test_information }} params: @@ -17,26 +16,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: get information test_information. +**Défaut**: get information test_information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -variable: example ----- diff --git a/tests/docs/no_namespace/00_8calculation_information.md b/tests/docs/no_namespace/00_8calculation_information.md index 391214e..6c3b967 100644 --- a/tests/docs/no_namespace/00_8calculation_information.md +++ b/tests/docs/no_namespace/00_8calculation_information.md @@ -10,7 +10,6 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: | {{test_information }} params: @@ -21,20 +20,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: get information test_information. | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -variable: example -``` diff --git a/tests/docs/no_namespace/00_8test.adoc b/tests/docs/no_namespace/00_8test.adoc index 94437eb..7251b67 100644 --- a/tests/docs/no_namespace/00_8test.adoc +++ b/tests/docs/no_namespace/00_8test.adoc @@ -3,81 +3,85 @@ [,yaml] ---- version: '1.1' + var1: description: the first variable test: - test + var2: description: the second variable test: - test default: value + var3: description: the third variable test: - test1 - test2 + var4: description: the forth variable test: - - test1 - test2 + mandatory: false + var5: description: the fifth variable + type: boolean test: - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 ---- == Variables -[cols="105a,105a",options="header"] +[cols="127a,127a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The first variable. + -**Example**: test +**Exemple**: test | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The second variable. + -**Default**: value + -**Example**: test +**Défaut**: value + +**Exemple**: test | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | The third variable. + -**Example**: test1 +**Exemple**: test1 | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | The forth variable. + -**Example**: None +**Exemple**: None | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The fifth variable. + -**Example**: False +**Défaut**: True + +**Exemple**: False +| +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The sixth variable. + +**Exemples**: + +* test1 +* test2 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: test -var2: test -var3: test1 -var5: false ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: test -var2: test -var3: test1 -var4: -var5: false ----- diff --git a/tests/docs/no_namespace/00_8test.md b/tests/docs/no_namespace/00_8test.md index 9f9c1ea..e661c21 100644 --- a/tests/docs/no_namespace/00_8test.md +++ b/tests/docs/no_namespace/00_8test.md @@ -7,58 +7,54 @@ include_toc: true ```yaml --- version: '1.1' + var1: description: the first variable test: - test + var2: description: the second variable test: - test default: value + var3: description: the third variable test: - test1 - test2 + var4: description: the forth variable test: - - test1 - test2 + mandatory: false + var5: description: the fifth variable + type: boolean test: - false + +var6: + description: the sixth variable + multi: true + test: + - test1 + - test2 ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
**Example**: test | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value
**Example**: test | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable.
**Example**: test1 | -| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The forth variable.
**Example**: None | -| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The fifth variable.
**Example**: False | +| Variable                                                                                                                      | Description                                                                                                                   | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable.
**Exemple**: test | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second variable.
**Défaut**: value
**Exemple**: test | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable.
**Exemple**: test1 | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Exemple**: None | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The fifth variable.
**Défaut**: True
**Exemple**: False | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The sixth variable.
**Exemples**:
- test1
- test2 | -# Example with mandatory variables not filled in - -```yaml ---- -var1: test -var2: test -var3: test1 -var5: false -``` -# Example with all variables modifiable - -```yaml ---- -var1: test -var2: test -var3: test1 -var4: -var5: false -``` diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.adoc b/tests/docs/no_namespace/00_9choice_variable_multi.adoc index 4944b56..e1c17d9 100644 --- a/tests/docs/no_namespace/00_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/00_9choice_variable_multi.adoc @@ -26,9 +26,9 @@ variable2: | Variable | Description | **variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` `unique` `multiple` | A first variable. + -**Choices**: +**Choix**: * val1 * val2 @@ -36,26 +36,10 @@ A first variable. + **variable2** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | A second variable. + -**Choices**: +**Choix**: * val1 * val2 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable1: - - a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -variable1: - - a_choice -variable2: - - a_choice ----- diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.md b/tests/docs/no_namespace/00_9choice_variable_multi.md index ab99f21..664986e 100644 --- a/tests/docs/no_namespace/00_9choice_variable_multi.md +++ b/tests/docs/no_namespace/00_9choice_variable_multi.md @@ -27,23 +27,7 @@ variable2: | Variable                                                                                                           | Description                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Choices**:
- val1
- val2 | -| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choices**:
- val1
- val2 | +| **variable1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first variable.
**Choix**:
- val1
- val2 | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A second variable.
**Choix**:
- val1
- val2 | -# Example with mandatory variables not filled in - -```yaml ---- -variable1: - - a_choice -``` -# Example with all variables modifiable - -```yaml ---- -variable1: - - a_choice -variable2: - - a_choice -``` diff --git a/tests/docs/no_namespace/00_9choice_variables.adoc b/tests/docs/no_namespace/00_9choice_variables.adoc new file mode 100644 index 0000000..3eac9c9 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variables.adoc @@ -0,0 +1,43 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +source_variable_1: val1 # the first source variable +source_variable_2: val2 # the second source variable +my_variable: + description: a variable + type: choice + choices: + - variable: _.source_variable_1 + - variable: _.source_variable_2 + default: val1 +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**source_variable_1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +The first source variable. + +**Défaut**: val1 +| +**source_variable_2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +The second source variable. + +**Défaut**: val2 +| +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | +A variable. + +**Choix**: + +* la valeur de la variable "source_variable_1". +* la valeur de la variable "source_variable_2". + +**Défaut**: val1 +|==== + + diff --git a/tests/docs/no_namespace/00_9choice_variables.md b/tests/docs/no_namespace/00_9choice_variables.md new file mode 100644 index 0000000..18e03d3 --- /dev/null +++ b/tests/docs/no_namespace/00_9choice_variables.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +source_variable_1: val1 # the first source variable +source_variable_2: val2 # the second source variable +my_variable: + description: a variable + type: choice + choices: + - variable: _.source_variable_1 + - variable: _.source_variable_2 + default: val1 +``` +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The first source variable.
**Défaut**: val1 | +| **source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The second source variable.
**Défaut**: val2 | +| **my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**:
- la valeur de la variable "source_variable_1".
- la valeur de la variable "source_variable_2".
**Défaut**: val1 | + + diff --git a/tests/docs/no_namespace/00_9default_calculation.adoc b/tests/docs/no_namespace/00_9default_calculation.adoc index 82aab71..8088f8e 100644 --- a/tests/docs/no_namespace/00_9default_calculation.adoc +++ b/tests/docs/no_namespace/00_9default_calculation.adoc @@ -3,10 +3,10 @@ [,yaml] ---- version: '1.1' + variable: description: a variable default: - type: jinja jinja: | {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} params: @@ -18,20 +18,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: concat all parameters. +**Défaut**: concat all parameters. |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: string_1_True_None ----- diff --git a/tests/docs/no_namespace/00_9default_calculation.md b/tests/docs/no_namespace/00_9default_calculation.md index c25991b..f0c879d 100644 --- a/tests/docs/no_namespace/00_9default_calculation.md +++ b/tests/docs/no_namespace/00_9default_calculation.md @@ -7,10 +7,10 @@ include_toc: true ```yaml --- version: '1.1' + variable: description: a variable default: - type: jinja jinja: | {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} params: @@ -22,14 +22,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: concat all parameters. | -# Example with all variables modifiable - -```yaml ---- -variable: string_1_True_None -``` diff --git a/tests/docs/no_namespace/00_9default_calculation_information.adoc b/tests/docs/no_namespace/00_9default_calculation_information.adoc index 1874e35..218ea92 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_information.adoc @@ -6,7 +6,6 @@ version: '1.1' var: description: a variable default: - type: jinja jinja: '{{ information }}' params: information: @@ -17,26 +16,14 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: returns the information. +**Défaut**: returns the information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: example ----- diff --git a/tests/docs/no_namespace/00_9default_calculation_information.md b/tests/docs/no_namespace/00_9default_calculation_information.md index a53f1a3..9ead6d9 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information.md +++ b/tests/docs/no_namespace/00_9default_calculation_information.md @@ -10,7 +10,6 @@ version: '1.1' var: description: a variable default: - type: jinja jinja: '{{ information }}' params: information: @@ -21,20 +20,8 @@ var: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: returns the information. | -# Example with mandatory variables not filled in - -```yaml ---- -var: example -``` -# Example with all variables modifiable - -```yaml ---- -var: example -``` diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc index d6811d8..4293f73 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc @@ -7,7 +7,6 @@ var1: # a first variable var2: description: a second variable default: - type: jinja jinja: | {{ information }} params: @@ -18,32 +17,18 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: issu d'un calcul. +**Défaut**: depends on a calculation. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: example -var2: example ----- diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md index 7cc598a..cacd21a 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.md @@ -11,7 +11,6 @@ var1: # a first variable var2: description: a second variable default: - type: jinja jinja: | {{ information }} params: @@ -22,23 +21,9 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: issu d'un calcul. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: depends on a calculation. | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: example -var2: example -``` diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc new file mode 100644 index 0000000..5272670 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +My_variable. + +**Défaut**: val1 +| +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: + +* la valeur de la variable "my_variable". +|==== + + diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.md b/tests/docs/no_namespace/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..0ac079b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable + optional: true + - variable: _.my_variable_unexists + optional: true +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | My_variable.
**Défaut**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**:
- la valeur de la variable "my_variable". | + + diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc new file mode 100644 index 0000000..f812eee --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +My_variable. + +**Défaut**: val1 +| +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: + +* la valeur de la variable "my_variable_unexists". +|==== + + diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..3c11935 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + default: val1 +my_calculated_variable: + multi: true + default: + - variable: _.my_variable_unexists + optional: true + - variable: _.my_variable + optional: true +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | My_variable.
**Défaut**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**:
- la valeur de la variable "my_variable_unexists". | + + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_optional.adoc new file mode 100644 index 0000000..0b7df9b --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional.adoc @@ -0,0 +1,23 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. +|==== + + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.md b/tests/docs/no_namespace/00_9default_calculation_optional.md new file mode 100644 index 0000000..b9dac89 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable. | + + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc new file mode 100644 index 0000000..634fea8 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc @@ -0,0 +1,37 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_variable. + +**Défaut**: + +* val1 +* val2 +| +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +My_calculated_variable. + +**Défaut**: la valeur de la variable "my_variable". +|==== + + diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.md b/tests/docs/no_namespace/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..d733514 --- /dev/null +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +my_variable: + multi: true + default: + - val1 + - val2 +my_calculated_variable: + multi: true + default: + variable: _.my_variable + optional: true +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_variable.
**Défaut**:
- val1
- val2 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | My_calculated_variable.
**Défaut**: la valeur de la variable "my_variable". | + + diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc index 08987da..445fcf2 100644 --- a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc @@ -6,20 +6,16 @@ version: '1.1' var1: description: a first variable default: - type: jinja jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' params: var2: - type: variable variable: _.var2 optional: true var3: - type: variable variable: _.var3 optional: true var4: - type: variable variable: _.unknown_family.var optional: true description: returns a value @@ -28,26 +24,19 @@ var2: no # a second variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | A first variable. + -**Default**: returns a value. +**Défaut**: returns a value. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: no ----- diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.md b/tests/docs/no_namespace/00_9default_calculation_param_optional.md index b6ee040..26d1b06 100644 --- a/tests/docs/no_namespace/00_9default_calculation_param_optional.md +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.md @@ -10,20 +10,16 @@ version: '1.1' var1: description: a first variable default: - type: jinja jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' params: var2: - type: variable variable: _.var2 optional: true var3: - type: variable variable: _.var3 optional: true var4: - type: variable variable: _.unknown_family.var optional: true description: returns a value @@ -32,16 +28,9 @@ var2: no # a second variable ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Default**: returns a value. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A first variable.
**Défaut**: returns a value. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: no -``` diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_information_other_variable.adoc index 7913c73..5a8f161 100644 --- a/tests/docs/no_namespace/00_9default_information_other_variable.adoc +++ b/tests/docs/no_namespace/00_9default_information_other_variable.adoc @@ -13,32 +13,18 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: value of the information. +**Défaut**: la valeur de information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: example -var2: example ----- diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.md b/tests/docs/no_namespace/00_9default_information_other_variable.md index 8883491..64f7f44 100644 --- a/tests/docs/no_namespace/00_9default_information_other_variable.md +++ b/tests/docs/no_namespace/00_9default_information_other_variable.md @@ -17,23 +17,9 @@ var2: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: la valeur de information. | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: example -var2: example -``` diff --git a/tests/docs/no_namespace/00_9default_integer.adoc b/tests/docs/no_namespace/00_9default_integer.adoc index 463bee8..47ec7b7 100644 --- a/tests/docs/no_namespace/00_9default_integer.adoc +++ b/tests/docs/no_namespace/00_9default_integer.adoc @@ -5,10 +5,8 @@ version: '1.1' var: description: a variable - type: choice default: 9 choices: - type: jinja jinja: | {% for item in trange(0, 10) %} {{ item }} @@ -18,21 +16,15 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A variable. + -**Choices**: choice for 0 to 9. + -**Default**: 9 +**Choix**: choice for 0 to 9. + +**Défaut**: 9 |==== -== Example with all variables modifiable - -[,yaml] ----- -var: 9 ----- diff --git a/tests/docs/no_namespace/00_9default_integer.md b/tests/docs/no_namespace/00_9default_integer.md index b1dcf66..b623f0a 100644 --- a/tests/docs/no_namespace/00_9default_integer.md +++ b/tests/docs/no_namespace/00_9default_integer.md @@ -9,10 +9,8 @@ include_toc: true version: '1.1' var: description: a variable - type: choice default: 9 choices: - type: jinja jinja: | {% for item in trange(0, 10) %} {{ item }} @@ -22,14 +20,8 @@ var: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Choix**: choice for 0 to 9.
**Défaut**: 9 | -# Example with all variables modifiable - -```yaml ---- -var: 9 -``` diff --git a/tests/docs/no_namespace/01_6boolean_multi.adoc b/tests/docs/no_namespace/01_6boolean_multi.adoc index 33b026e..4ee39ce 100644 --- a/tests/docs/no_namespace/01_6boolean_multi.adoc +++ b/tests/docs/no_namespace/01_6boolean_multi.adoc @@ -40,86 +40,65 @@ var8: ---- == Variables -[cols="129a,129a",options="header"] +[cols="131a,131a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* true +* true | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* true +* true | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* true +* true | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* false +* false | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* false +* false | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* false +* false | **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* true +* true | **var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* true +* true |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - true -var2: - - true -var3: - - true -var4: - - false -var5: - - false -var6: - - false -var7: - - true -var8: - - true ----- diff --git a/tests/docs/no_namespace/01_6boolean_multi.md b/tests/docs/no_namespace/01_6boolean_multi.md index e159f72..8263a76 100644 --- a/tests/docs/no_namespace/01_6boolean_multi.md +++ b/tests/docs/no_namespace/01_6boolean_multi.md @@ -44,36 +44,15 @@ var8: ``` # Variables -| Variable                                                                                                                        | Description                                                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- true | -| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- true | -| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- true | -| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- false | -| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- false | -| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- false | -| **var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- true | -| **var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- true | +| Variable                                                                                                                          | Description                                                                                                                       | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- true | +| **var2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- true | +| **var3**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- true | +| **var4**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- false | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- false | +| **var6**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- false | +| **var7**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- true | +| **var8**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- true | -# Example with all variables modifiable - -```yaml ---- -var1: - - true -var2: - - true -var3: - - true -var4: - - false -var5: - - false -var6: - - false -var7: - - true -var8: - - true -``` diff --git a/tests/docs/no_namespace/01_6custom_multi.adoc b/tests/docs/no_namespace/01_6custom_multi.adoc index f8c7af3..670c08a 100644 --- a/tests/docs/no_namespace/01_6custom_multi.adoc +++ b/tests/docs/no_namespace/01_6custom_multi.adoc @@ -15,36 +15,20 @@ custom2: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **custom1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | -A first custom variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `obligatoire` `unique` `multiple` | +A first custom variable. | **custom2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `obligatoire` `unique` `multiple` | A second custom variable. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -custom1: - - xxx ----- -== Example with all variables modifiable - -[,yaml] ----- -custom1: - - xxx -custom2: - - value ----- diff --git a/tests/docs/no_namespace/01_6custom_multi.md b/tests/docs/no_namespace/01_6custom_multi.md index e4c7909..e728172 100644 --- a/tests/docs/no_namespace/01_6custom_multi.md +++ b/tests/docs/no_namespace/01_6custom_multi.md @@ -19,25 +19,9 @@ custom2: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first custom variable. | -| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second custom variable.
**Default**:
- value | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **custom1**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A first custom variable. | +| **custom2**
[`custom`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second custom variable.
**Défaut**:
- value | -# Example with mandatory variables not filled in - -```yaml ---- -custom1: - - xxx -``` -# Example with all variables modifiable - -```yaml ---- -custom1: - - xxx -custom2: - - value -``` diff --git a/tests/docs/no_namespace/01_6float_multi.adoc b/tests/docs/no_namespace/01_6float_multi.adoc index 77dfb93..33db2a1 100644 --- a/tests/docs/no_namespace/01_6float_multi.adoc +++ b/tests/docs/no_namespace/01_6float_multi.adoc @@ -40,86 +40,65 @@ var8: ---- == Variables -[cols="127a,127a",options="header"] +[cols="129a,129a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* 10.1 +* 10.1 | **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 | **var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* 0.0 +* 0.0 |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - 0.0 -var2: - - 0.0 -var3: - - 0.0 -var4: - - 10.1 -var5: - - 10.1 -var6: - - 10.1 -var7: - - 0.0 -var8: - - 0.0 ----- diff --git a/tests/docs/no_namespace/01_6float_multi.md b/tests/docs/no_namespace/01_6float_multi.md index 250b24a..b8768d9 100644 --- a/tests/docs/no_namespace/01_6float_multi.md +++ b/tests/docs/no_namespace/01_6float_multi.md @@ -44,36 +44,15 @@ var8: ``` # Variables -| Variable                                                                                                                      | Description                                                                                                                   | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0.0 | -| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0.0 | -| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0.0 | -| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10.1 | -| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10.1 | -| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10.1 | -| **var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0.0 | -| **var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0.0 | +| Variable                                                                                                                        | Description                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- 0.0 | +| **var2**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- 0.0 | +| **var3**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- 0.0 | +| **var4**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- 10.1 | +| **var5**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- 10.1 | +| **var6**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- 10.1 | +| **var7**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- 0.0 | +| **var8**
[`float`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- 0.0 | -# Example with all variables modifiable - -```yaml ---- -var1: - - 0.0 -var2: - - 0.0 -var3: - - 0.0 -var4: - - 10.1 -var5: - - 10.1 -var6: - - 10.1 -var7: - - 0.0 -var8: - - 0.0 -``` diff --git a/tests/docs/no_namespace/01_6number_multi.adoc b/tests/docs/no_namespace/01_6number_multi.adoc index 5c8bdb3..ecd2410 100644 --- a/tests/docs/no_namespace/01_6number_multi.adoc +++ b/tests/docs/no_namespace/01_6number_multi.adoc @@ -40,86 +40,65 @@ var8: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The first variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The second variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The third variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* 10 +* 10 | **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* 0 +* 0 | **var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* 0 +* 0 |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - 0 -var2: - - 0 -var3: - - 0 -var4: - - 10 -var5: - - 10 -var6: - - 10 -var7: - - 0 -var8: - - 0 ----- diff --git a/tests/docs/no_namespace/01_6number_multi.md b/tests/docs/no_namespace/01_6number_multi.md index d2507a2..e1b199c 100644 --- a/tests/docs/no_namespace/01_6number_multi.md +++ b/tests/docs/no_namespace/01_6number_multi.md @@ -44,36 +44,15 @@ var8: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The first variable.
**Default**:
- 0 | -| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- 0 | -| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The third variable.
**Default**:
- 0 | -| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- 10 | -| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- 10 | -| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- 10 | -| **var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- 0 | -| **var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- 0 | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The first variable.
**Défaut**:
- 0 | +| **var2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- 0 | +| **var3**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The third variable.
**Défaut**:
- 0 | +| **var4**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- 10 | +| **var5**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- 10 | +| **var6**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- 10 | +| **var7**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- 0 | +| **var8**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- 0 | -# Example with all variables modifiable - -```yaml ---- -var1: - - 0 -var2: - - 0 -var3: - - 0 -var4: - - 10 -var5: - - 10 -var6: - - 10 -var7: - - 0 -var8: - - 0 -``` diff --git a/tests/docs/no_namespace/01_6string_empty.adoc b/tests/docs/no_namespace/01_6string_empty.adoc new file mode 100644 index 0000000..2f90d46 --- /dev/null +++ b/tests/docs/no_namespace/01_6string_empty.adoc @@ -0,0 +1,26 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' +var1: + description: the second variable + empty: false + default: [value, None] +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +The second variable. + +**Défaut**: + +* value +* None +|==== + + diff --git a/tests/docs/no_namespace/01_6string_empty.md b/tests/docs/no_namespace/01_6string_empty.md new file mode 100644 index 0000000..817d0ee --- /dev/null +++ b/tests/docs/no_namespace/01_6string_empty.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: the second variable + empty: false + default: [value, None] +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The second variable.
**Défaut**:
- value
- None | + + diff --git a/tests/docs/no_namespace/01_6string_multi.adoc b/tests/docs/no_namespace/01_6string_multi.adoc index 7e493a3..144864e 100644 --- a/tests/docs/no_namespace/01_6string_multi.adoc +++ b/tests/docs/no_namespace/01_6string_multi.adoc @@ -36,86 +36,56 @@ var8: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The first variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The second variable. | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The third variable. | **var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The forth variable. + -**Default**: +**Défaut**: -* value +* value | **var5** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The fifth variable. + -**Default**: +**Défaut**: -* value +* value | **var6** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The sixth variable. + -**Default**: +**Défaut**: -* value +* value | **var7** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The seventh variable. + -**Default**: +**Défaut**: -* value +* value | **var8** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | The eighth variable. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: - - example -var2: - - example -var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: - - example -var2: - - example -var3: example -var4: - - value -var5: - - value -var6: - - value -var7: - - value -var8: - - value ----- diff --git a/tests/docs/no_namespace/01_6string_multi.md b/tests/docs/no_namespace/01_6string_multi.md index 72b0c5b..8bddc25 100644 --- a/tests/docs/no_namespace/01_6string_multi.md +++ b/tests/docs/no_namespace/01_6string_multi.md @@ -40,45 +40,15 @@ var8: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The first variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The second variable. | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable. | -| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The forth variable.
**Default**:
- value | -| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The fifth variable.
**Default**:
- value | -| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The sixth variable.
**Default**:
- value | -| **var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The seventh variable.
**Default**:
- value | -| **var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The eighth variable.
**Default**:
- value | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The first variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The second variable. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The third variable. | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The forth variable.
**Défaut**:
- value | +| **var5**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The fifth variable.
**Défaut**:
- value | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The sixth variable.
**Défaut**:
- value | +| **var7**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The seventh variable.
**Défaut**:
- value | +| **var8**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | The eighth variable.
**Défaut**:
- value | -# Example with mandatory variables not filled in - -```yaml ---- -var1: - - example -var2: - - example -var3: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: - - example -var2: - - example -var3: example -var4: - - value -var5: - - value -var6: - - value -var7: - - value -var8: - - value -``` diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc index c1adb64..45e4d41 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc @@ -10,23 +10,16 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote" +* quote" |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - quote" ----- diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.md b/tests/docs/no_namespace/01_7value_multi_doublequote.md index c9c8533..63f94ac 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote.md +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.md @@ -14,15 +14,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote" | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote" | -# Example with all variables modifiable - -```yaml ---- -variable: - - quote" -``` diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc index 20fa4b3..5f1f469 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc @@ -10,23 +10,16 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote'" +* quote'" |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - quote'" ----- diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.md b/tests/docs/no_namespace/01_7value_multi_doublequote2.md index c98f7dd..3898877 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote2.md +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.md @@ -14,15 +14,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote'" | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote'" | -# Example with all variables modifiable - -```yaml ---- -variable: - - quote'" -``` diff --git a/tests/docs/no_namespace/01_7value_multi_quote.adoc b/tests/docs/no_namespace/01_7value_multi_quote.adoc index bc6e1af..ae29380 100644 --- a/tests/docs/no_namespace/01_7value_multi_quote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_quote.adoc @@ -10,23 +10,16 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* quote' +* quote' |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - quote' ----- diff --git a/tests/docs/no_namespace/01_7value_multi_quote.md b/tests/docs/no_namespace/01_7value_multi_quote.md index 3a79dd8..00dd814 100644 --- a/tests/docs/no_namespace/01_7value_multi_quote.md +++ b/tests/docs/no_namespace/01_7value_multi_quote.md @@ -14,15 +14,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- quote' | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- quote' | -# Example with all variables modifiable - -```yaml ---- -variable: - - quote' -``` diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.adoc b/tests/docs/no_namespace/01_8calculation_information_multi.adoc index 95cd54a..2780f78 100644 --- a/tests/docs/no_namespace/01_8calculation_information_multi.adoc +++ b/tests/docs/no_namespace/01_8calculation_information_multi.adoc @@ -7,7 +7,6 @@ variable: description: a variable multi: true default: - type: jinja jinja: | {{test_information }} params: @@ -18,21 +17,14 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: get information test_information. +**Défaut**: get information test_information. |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - '[]' ----- diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.md b/tests/docs/no_namespace/01_8calculation_information_multi.md index 544f436..c0744cb 100644 --- a/tests/docs/no_namespace/01_8calculation_information_multi.md +++ b/tests/docs/no_namespace/01_8calculation_information_multi.md @@ -11,7 +11,6 @@ variable: description: a variable multi: true default: - type: jinja jinja: | {{test_information }} params: @@ -22,15 +21,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**: get information test_information. | -# Example with all variables modifiable - -```yaml ---- -variable: - - '[]' -``` diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.adoc b/tests/docs/no_namespace/01_9choice_variable_multi.adoc index 54d6542..2bf0e75 100644 --- a/tests/docs/no_namespace/01_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/01_9choice_variable_multi.adoc @@ -10,44 +10,27 @@ variable1: # a first variable variable2: description: a second variable choices: - type: variable variable: _.variable1 ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: * a * b -* c +* c | **variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A second variable. + -**Choices**: the value of the variable "variable1". +**Choix**: la valeur de la variable "variable1". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable2: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -variable1: - - a - - b - - c -variable2: a_choice ----- diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.md b/tests/docs/no_namespace/01_9choice_variable_multi.md index b9c7374..a941cd4 100644 --- a/tests/docs/no_namespace/01_9choice_variable_multi.md +++ b/tests/docs/no_namespace/01_9choice_variable_multi.md @@ -14,30 +14,13 @@ variable1: # a first variable variable2: description: a second variable choices: - type: variable variable: _.variable1 ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- a
- b
- c | -| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable.
**Choices**: the value of the variable "variable1". | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- a
- b
- c | +| **variable2**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second variable.
**Choix**: la valeur de la variable "variable1". | -# Example with mandatory variables not filled in - -```yaml ---- -variable2: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -variable1: - - a - - b - - c -variable2: a_choice -``` diff --git a/tests/docs/no_namespace/04_0type_param.adoc b/tests/docs/no_namespace/04_0type_param.adoc index c5157bd..c6e7f83 100644 --- a/tests/docs/no_namespace/04_0type_param.adoc +++ b/tests/docs/no_namespace/04_0type_param.adoc @@ -5,36 +5,26 @@ version: '1.1' int: description: A limited number - type: number + default: 10 params: min_number: 0 max_number: 100 ---- == Variables -[cols="105a,105a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A limited number. + **Validators**: -* the minimum value is 0 -* the maximum value is 100 +* le valeur minimal est 0 +* le valeur maximal est 100 + +**Défaut**: 10 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -int: 42 ----- diff --git a/tests/docs/no_namespace/04_0type_param.md b/tests/docs/no_namespace/04_0type_param.md index 0260585..fd3a714 100644 --- a/tests/docs/no_namespace/04_0type_param.md +++ b/tests/docs/no_namespace/04_0type_param.md @@ -9,27 +9,15 @@ include_toc: true version: '1.1' int: description: A limited number - type: number + default: 10 params: min_number: 0 max_number: 100 ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A limited number.
**Validators**:
- le valeur minimal est 0
- le valeur maximal est 100
**Défaut**: 10 | -# Example with mandatory variables not filled in - -```yaml ---- -int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -int: 42 -``` diff --git a/tests/docs/no_namespace/04_1auto_save.adoc b/tests/docs/no_namespace/04_1auto_save.adoc index f2d6aa0..ad02b1c 100644 --- a/tests/docs/no_namespace/04_1auto_save.adoc +++ b/tests/docs/no_namespace/04_1auto_save.adoc @@ -10,20 +10,14 @@ variable: ---- == Variables -[cols="121a,121a",options="header"] +[cols="123a,123a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `auto modifiée` | An auto save variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: no ----- diff --git a/tests/docs/no_namespace/04_1auto_save.md b/tests/docs/no_namespace/04_1auto_save.md index 70ca72b..45c3c35 100644 --- a/tests/docs/no_namespace/04_1auto_save.md +++ b/tests/docs/no_namespace/04_1auto_save.md @@ -14,14 +14,8 @@ variable: ``` # Variables -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | +| Variable                                                                                                                  | Description                                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `auto modifiée` | An auto save variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -variable: no -``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc index 9bc2820..2d04d01 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc @@ -8,31 +8,23 @@ var2: description: a second variable auto_save: true default: - type: variable variable: _.var1 ---- == Variables -[cols="121a,121a",options="header"] +[cols="123a,123a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `auto modifiée` | A second variable. + -**Default**: the value of the variable "var1". +**Défaut**: la valeur de la variable "var1". |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: no ----- diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.md b/tests/docs/no_namespace/04_1auto_save_and_calculated.md index 788b29f..6ceac47 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated.md +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.md @@ -12,21 +12,13 @@ var2: description: a second variable auto_save: true default: - type: variable variable: _.var1 ``` # Variables -| Variable                                                                                                                | Description                                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | A second variable.
**Default**: the value of the variable "var1". | +| Variable                                                                                                                  | Description                                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `auto modifiée` | A second variable.
**Défaut**: la valeur de la variable "var1". | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: no -``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc index b35d393..02be30a 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc @@ -8,40 +8,31 @@ var2: description: a second variable auto_save: true hidden: - type: jinja jinja: | {% if _.var1 == "yes" %} _.var1 is yes {% endif %} description: only if the variable var1 has value "yes" default: - type: jinja jinja: yes description: the value is always yes ---- == Variables -[cols="132a,132a",options="header"] +[cols="133a,133a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`caché`_ `auto modifiée` | A second variable. + -**Default**: the value is always yes. + -**Hidden**: only if the variable var1 has value "yes". +**Défaut**: the value is always yes. + +**Caché**: only if the variable var1 has value "yes". |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: yes ----- diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md index cc2dee5..7868f8b 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md @@ -12,29 +12,20 @@ var2: description: a second variable auto_save: true hidden: - type: jinja jinja: | {% if _.var1 == "yes" %} _.var1 is yes {% endif %} description: only if the variable var1 has value "yes" default: - type: jinja jinja: yes description: the value is always yes ``` # Variables -| Variable                                                                                                                           | Description                                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | +| Variable                                                                                                                            | Description                                                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`caché`_ `auto modifiée` | A second variable.
**Défaut**: the value is always yes.
**Caché**: only if the variable var1 has value "yes". | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: yes -``` diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc index e8bea5c..4dfe262 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc @@ -8,4 +8,5 @@ var: auto_save: true hidden: true default: yes + mandatory: false ---- diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_hidden.md index 7bbe9eb..eb23d55 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_hidden.md +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.md @@ -12,4 +12,5 @@ var: auto_save: true hidden: true default: yes + mandatory: false ``` diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc new file mode 100644 index 0000000..1ff79f4 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A first variable. + +**Défaut**: value +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | +A second variable. + +**Désactivé**: when the variable "var1" has the value "value". +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A third variable. + +**Défaut**: depends on a calculation. +|==== + + diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.md b/tests/docs/no_namespace/04_1default_calculation_hidden.md new file mode 100644 index 0000000..fc504c1 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var1 == 'value' or _.var2 == 'blah' %} + value + {% endif %} +``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A second variable.
**Désactivé**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: depends on a calculation. | + + diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc new file mode 100644 index 0000000..1e97087 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +---- +== Variables + +[cols="110a,110a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A first variable. + +**Défaut**: value +| +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | +A second variable. + +**Désactivé**: when the variable "var1" has the value "value". +| +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +A third variable. + +**Défaut**: depends on a calculation. +|==== + + diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.md b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..f756464 --- /dev/null +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +var1: + description: a first variable + default: value + +var2: + description: a second variable + disabled: + variable: _.var1 + when: value + +var3: + description: a third variable + default: + jinja: | + {% if _.var2 is propertyerror %} + value + {% endif %} +``` +# Variables + +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A second variable.
**Désactivé**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: depends on a calculation. | + + diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc index d5b8c3d..2dedeef 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc @@ -7,71 +7,54 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if unknown is not defined %} unknown is undefined {% elif unknown == "no" %} unknown is no {% endif %} - params: - unknown: - type: variable - variable: _.unknown - optional: true + params: + unknown: + variable: _.unknown + optional: true description: calculation from an unknown variable + mandatory: false var2: description: a second variable hidden: - type: jinja jinja: | {% if condition is not defined %} condition is undefined {% elif condition == "no" %} condition is no {% endif %} - params: - condition: - type: variable - variable: _.condition - optional: true + params: + condition: + variable: _.condition + optional: true description: calculation from an condition variable + mandatory: false ---- == Variables -[cols="116a,116a",options="header"] +[cols="106a,106a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`caché`_ | A first variable. + -**Hidden**: calculation from an unknown variable. +**Caché**: calculation from an unknown variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`caché`_ | A second variable. + -**Hidden**: calculation from an condition variable. +**Caché**: calculation from an condition variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: no -var1: example -var2: example ----- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.md b/tests/docs/no_namespace/04_5disabled_calculation_optional.md index 6431a5f..7ff2650 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.md @@ -11,57 +11,40 @@ condition: no # a condition var1: description: a first variable hidden: - type: jinja jinja: | {% if unknown is not defined %} unknown is undefined {% elif unknown == "no" %} unknown is no {% endif %} - params: - unknown: - type: variable - variable: _.unknown - optional: true + params: + unknown: + variable: _.unknown + optional: true description: calculation from an unknown variable + mandatory: false var2: description: a second variable hidden: - type: jinja jinja: | {% if condition is not defined %} condition is undefined {% elif condition == "no" %} condition is no {% endif %} - params: - condition: - type: variable - variable: _.condition - optional: true + params: + condition: + variable: _.condition + optional: true description: calculation from an condition variable + mandatory: false ``` # Variables -| Variable                                                                                                           | Description                                                                                                        | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`caché`_ | A first variable.
**Caché**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`caché`_ | A second variable.
**Caché**: calculation from an condition variable. | -# Example with mandatory variables not filled in - -```yaml ---- -var1: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: no -var1: example -var2: example -``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc index 1c06d39..fb01075 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc @@ -7,37 +7,23 @@ condition: false # a condition variable: description: a variable disabled: - type: variable variable: _.condition ---- == Variables -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: False +**Défaut**: False | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "condition" has the value "True". +**Désactivé**: when the variable "condition" has the value "True". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: false -variable: example ----- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.md b/tests/docs/no_namespace/04_5disabled_calculation_variable.md index f051333..df5f5a4 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.md @@ -11,27 +11,13 @@ condition: false # a condition variable: description: a variable disabled: - type: variable variable: _.condition ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: False | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "condition" has the value "True". | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: false -variable: example -``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc index 199a789..9587364 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc @@ -7,37 +7,23 @@ condition: true # a condition variable: description: a variable disabled: - type: variable variable: _.condition ---- == Variables -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: True +**Défaut**: True | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "condition" has the value "True". +**Désactivé**: when the variable "condition" has the value "True". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: true -variable: example ----- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md index ded660c..5a59ce4 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md @@ -11,27 +11,13 @@ condition: true # a condition variable: description: a variable disabled: - type: variable variable: _.condition ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: True | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "condition" has the value "True". | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: true -variable: example -``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc index 20c319d..a9c65a9 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc @@ -7,38 +7,24 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when: yes ---- == Variables -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "condition" has the value "yes". +**Désactivé**: when the variable "condition" has the value "yes". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: yes -variable: example ----- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md index 25d7dc5..ebec620 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md @@ -11,28 +11,14 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when: yes ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "yes". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "condition" has the value "yes". | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: yes -variable: example -``` diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc index f611be7..c300081 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc @@ -7,38 +7,24 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when_not: yes ---- == Variables -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A variable. + -**Disabled**: when the variable "condition" hasn't the value "yes". +**Désactivé**: when the variable "condition" hasn't the value "yes". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: yes -variable: example ----- diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md index 32ea32a..ddb07bc 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md @@ -11,28 +11,14 @@ condition: yes # a condition variable: description: a variable disabled: - type: variable variable: _.condition when_not: yes ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" hasn't the value "yes". | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A variable.
**Désactivé**: when the variable "condition" hasn't the value "yes". | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: yes -variable: example -``` diff --git a/tests/docs/no_namespace/04_5validators.adoc b/tests/docs/no_namespace/04_5validators.adoc index ea38555..3befe4e 100644 --- a/tests/docs/no_namespace/04_5validators.adoc +++ b/tests/docs/no_namespace/04_5validators.adoc @@ -7,8 +7,7 @@ int: description: A number type: number validators: - - type: jinja - jinja: | + - jinja: | {% if _.int > 100 %} value is too high {% endif %} @@ -16,26 +15,14 @@ int: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `obligatoire` | A number. + -**Validator**: the max value is 100. +**Validator**: the max value is 100. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -int: 42 ----- diff --git a/tests/docs/no_namespace/04_5validators.md b/tests/docs/no_namespace/04_5validators.md index deb5ce9..4ac2a32 100644 --- a/tests/docs/no_namespace/04_5validators.md +++ b/tests/docs/no_namespace/04_5validators.md @@ -11,8 +11,7 @@ int: description: A number type: number validators: - - type: jinja - jinja: | + - jinja: | {% if _.int > 100 %} value is too high {% endif %} @@ -20,20 +19,8 @@ int: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A number.
**Validator**: the max value is 100. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A number.
**Validator**: the max value is 100. | -# Example with mandatory variables not filled in - -```yaml ---- -int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -int: 42 -``` diff --git a/tests/docs/no_namespace/04_5validators_differ.adoc b/tests/docs/no_namespace/04_5validators_differ.adoc index 3ea2154..03d539a 100644 --- a/tests/docs/no_namespace/04_5validators_differ.adoc +++ b/tests/docs/no_namespace/04_5validators_differ.adoc @@ -5,11 +5,12 @@ version: '1.1' var1: description: a first variable + test: + - another_value type: string default: oui validators: - - type: jinja - jinja: | + - jinja: | {% if _.var1 == _.var2 %} var1 must be different than var2 {% endif %} @@ -18,27 +19,21 @@ var2: no # A second variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + **Validator**: var1 must be different than var2. + -**Default**: oui +**Défaut**: oui + +**Exemple**: another_value | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: oui -var2: no ----- diff --git a/tests/docs/no_namespace/04_5validators_differ.md b/tests/docs/no_namespace/04_5validators_differ.md index c79ad6b..8f07e3b 100644 --- a/tests/docs/no_namespace/04_5validators_differ.md +++ b/tests/docs/no_namespace/04_5validators_differ.md @@ -9,11 +9,12 @@ include_toc: true version: '1.1' var1: description: a first variable + test: + - another_value type: string default: oui validators: - - type: jinja - jinja: | + - jinja: | {% if _.var1 == _.var2 %} var1 must be different than var2 {% endif %} @@ -22,16 +23,9 @@ var2: no # A second variable ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: var1 must be different than var2.
**Default**: oui | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Validator**: var1 must be different than var2.
**Défaut**: oui
**Exemple**: another_value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | -# Example with all variables modifiable - -```yaml ---- -var1: oui -var2: no -``` diff --git a/tests/docs/no_namespace/04_5validators_multi.adoc b/tests/docs/no_namespace/04_5validators_multi.adoc new file mode 100644 index 0000000..97035db --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi.adoc @@ -0,0 +1,35 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 10. + +**Défaut**: + +* no +* yes +|==== + + diff --git a/tests/docs/no_namespace/04_5validators_multi.md b/tests/docs/no_namespace/04_5validators_multi.md new file mode 100644 index 0000000..9e552a7 --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + validators: + - jinja: | + {% if _.var1 | length > 9 %} + length must be less than 10 + {% endif %} + description: check length is less than 10 +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Défaut**:
- no
- yes | + + diff --git a/tests/docs/no_namespace/04_5validators_multi2.adoc b/tests/docs/no_namespace/04_5validators_multi2.adoc new file mode 100644 index 0000000..1453add --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi2.adoc @@ -0,0 +1,47 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +---- +== Variables + +[cols="130a,130a",options="header"] +|==== +| Variable | Description +| +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 3. + +**Défaut**: + +* no +* yes + +**Exemples**: + +* val1 +* val2 +|==== + + diff --git a/tests/docs/no_namespace/04_5validators_multi2.md b/tests/docs/no_namespace/04_5validators_multi2.md new file mode 100644 index 0000000..c0a173a --- /dev/null +++ b/tests/docs/no_namespace/04_5validators_multi2.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 +var1: + description: a second variable + multi: true + default: + - no + - yes + test: + - val1 + - val2 + validators: + - params: + values: + variable: _.var1 + whole: true + jinja: | + {% if values | length > 2 %} + length must be less than 3 + {% endif %} + description: check length is less than 3 +``` +# Variables + +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Défaut**:
- no
- yes
**Exemples**:
- val1
- val2 | + + diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.adoc b/tests/docs/no_namespace/04_7validators_variable_optional.adoc index 1a15e7d..5ce79e4 100644 --- a/tests/docs/no_namespace/04_7validators_variable_optional.adoc +++ b/tests/docs/no_namespace/04_7validators_variable_optional.adoc @@ -7,26 +7,24 @@ general: # a family int: description: a first number type: number + test: + - 5 validators: - - type: jinja - jinja: | + - jinja: | {% if _.int == int2 %} int and int2 must be different {% endif %} params: int2: - type: variable variable: _.int2 optional: true description: int and int2 must be different - - type: jinja - jinja: | - {% if _.int == int3 %} + - jinja: | + {% if int3 is defined and _.int == int3 %} int and int3 must be different {% endif %} params: int3: - type: variable variable: _.int3 optional: true description: int and int3 must be different @@ -38,37 +36,24 @@ general: # a family `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **general.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `obligatoire` | A first number. + **Validators**: * int and int2 must be different. -* int and int3 must be different. +* int and int3 must be different. + +**Exemple**: 5 | **general.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `obligatoire` | A second number. + -**Default**: 1 +**Défaut**: 1 |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -general: - int: 42 ----- -== Example with all variables modifiable - -[,yaml] ----- -general: - int: 42 - int2: 1 ----- diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.md b/tests/docs/no_namespace/04_7validators_variable_optional.md index 13b0d1d..54bb113 100644 --- a/tests/docs/no_namespace/04_7validators_variable_optional.md +++ b/tests/docs/no_namespace/04_7validators_variable_optional.md @@ -11,26 +11,24 @@ general: # a family int: description: a first number type: number + test: + - 5 validators: - - type: jinja - jinja: | + - jinja: | {% if _.int == int2 %} int and int2 must be different {% endif %} params: int2: - type: variable variable: _.int2 optional: true description: int and int2 must be different - - type: jinja - jinja: | - {% if _.int == int3 %} + - jinja: | + {% if int3 is defined and _.int == int3 %} int and int3 must be different {% endif %} params: int3: - type: variable variable: _.int3 optional: true description: int and int3 must be different @@ -42,24 +40,9 @@ general: # a family `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different. | -| **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first number.
**Validators**:
- int and int2 must be different.
- int and int3 must be different.
**Exemple**: 5 | +| **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second number.
**Défaut**: 1 | -# Example with mandatory variables not filled in - -```yaml ---- -general: - int: 42 -``` -# Example with all variables modifiable - -```yaml ---- -general: - int: 42 - int2: 1 -``` diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.adoc b/tests/docs/no_namespace/05_0multi_not_uniq.adoc index b65e635..c0f68ef 100644 --- a/tests/docs/no_namespace/05_0multi_not_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_not_uniq.adoc @@ -11,23 +11,16 @@ var1: ---- == Variables -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - non ----- diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.md b/tests/docs/no_namespace/05_0multi_not_uniq.md index 95b27cd..9fc5d1a 100644 --- a/tests/docs/no_namespace/05_0multi_not_uniq.md +++ b/tests/docs/no_namespace/05_0multi_not_uniq.md @@ -15,15 +15,8 @@ var1: ``` # Variables -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -var1: - - non -``` diff --git a/tests/docs/no_namespace/05_0multi_uniq.adoc b/tests/docs/no_namespace/05_0multi_uniq.adoc index 7748dc9..9f8aa19 100644 --- a/tests/docs/no_namespace/05_0multi_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_uniq.adoc @@ -11,23 +11,16 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - non ----- diff --git a/tests/docs/no_namespace/05_0multi_uniq.md b/tests/docs/no_namespace/05_0multi_uniq.md index 1b3ec1a..baf3bdb 100644 --- a/tests/docs/no_namespace/05_0multi_uniq.md +++ b/tests/docs/no_namespace/05_0multi_uniq.md @@ -15,15 +15,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -variable: - - non -``` diff --git a/tests/docs/no_namespace/16_0redefine_description.adoc b/tests/docs/no_namespace/16_0redefine_description.adoc index f4080fb..853c993 100644 --- a/tests/docs/no_namespace/16_0redefine_description.adoc +++ b/tests/docs/no_namespace/16_0redefine_description.adoc @@ -17,25 +17,13 @@ var: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Redefined. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Redefined. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: example ----- diff --git a/tests/docs/no_namespace/16_0redefine_description.md b/tests/docs/no_namespace/16_0redefine_description.md index 11098a3..07bcad5 100644 --- a/tests/docs/no_namespace/16_0redefine_description.md +++ b/tests/docs/no_namespace/16_0redefine_description.md @@ -21,20 +21,8 @@ var: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Redefined. | -# Example with mandatory variables not filled in - -```yaml ---- -var: example -``` -# Example with all variables modifiable - -```yaml ---- -var: example -``` diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc index 7474dc0..5e2cb23 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc @@ -6,7 +6,6 @@ version: '1.0' family: redefine: true disabled: - type: jinja jinja: | true ---- @@ -22,31 +21,17 @@ family: === family -`basic` _`disabled`_ +`basic` _`désactivé`_ -**Disabled**: issu d'un calcul. +**Désactivé**: depends on a calculation. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Var1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Var1. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - var1: example ----- diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.md b/tests/docs/no_namespace/16_2family_redefine_calculation.md index e24540c..94078c7 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.md +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.md @@ -10,7 +10,6 @@ version: '1.0' family: redefine: true disabled: - type: jinja jinja: | true ``` @@ -26,26 +25,12 @@ family: ## family -`basic` _`disabled`_ +`basic` _`désactivé`_ -**Disabled**: issu d'un calcul. +**Désactivé**: depends on a calculation. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Var1. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - var1: example -``` diff --git a/tests/docs/no_namespace/16_5exists_nonexists.adoc b/tests/docs/no_namespace/16_5exists_nonexists.adoc index 5cfd257..4700ebf 100644 --- a/tests/docs/no_namespace/16_5exists_nonexists.adoc +++ b/tests/docs/no_namespace/16_5exists_nonexists.adoc @@ -17,26 +17,19 @@ var1: no # a variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A new variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: yes ----- diff --git a/tests/docs/no_namespace/16_5exists_nonexists.md b/tests/docs/no_namespace/16_5exists_nonexists.md index 4564532..8b2ec37 100644 --- a/tests/docs/no_namespace/16_5exists_nonexists.md +++ b/tests/docs/no_namespace/16_5exists_nonexists.md @@ -21,16 +21,9 @@ var1: no # a variable ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A new variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A new variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: yes -``` diff --git a/tests/docs/no_namespace/16_5exists_redefine.adoc b/tests/docs/no_namespace/16_5exists_redefine.adoc index 04d36a1..ffd4c3d 100644 --- a/tests/docs/no_namespace/16_5exists_redefine.adoc +++ b/tests/docs/no_namespace/16_5exists_redefine.adoc @@ -22,4 +22,5 @@ var1: description: a first variable hidden: true default: no + mandatory: false ---- diff --git a/tests/docs/no_namespace/16_5exists_redefine.md b/tests/docs/no_namespace/16_5exists_redefine.md index 40f84ee..695da7d 100644 --- a/tests/docs/no_namespace/16_5exists_redefine.md +++ b/tests/docs/no_namespace/16_5exists_redefine.md @@ -26,4 +26,5 @@ var1: description: a first variable hidden: true default: no + mandatory: false ``` diff --git a/tests/docs/no_namespace/16_5redefine_calculation.adoc b/tests/docs/no_namespace/16_5redefine_calculation.adoc index a7e615f..0c6c5c5 100644 --- a/tests/docs/no_namespace/16_5redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_calculation.adoc @@ -6,7 +6,6 @@ version: '1.1' variable: redefine: true default: - type: jinja jinja: yes description: returns yes ---- @@ -18,26 +17,19 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: returns no ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: returns yes. +**Défaut**: returns yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: yes ----- diff --git a/tests/docs/no_namespace/16_5redefine_calculation.md b/tests/docs/no_namespace/16_5redefine_calculation.md index 72bc16a..c023757 100644 --- a/tests/docs/no_namespace/16_5redefine_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_calculation.md @@ -10,7 +10,6 @@ version: '1.1' variable: redefine: true default: - type: jinja jinja: yes description: returns yes ``` @@ -22,20 +21,13 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: no description: returns no ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: returns yes. | -# Example with all variables modifiable - -```yaml ---- -variable: yes -``` diff --git a/tests/docs/no_namespace/16_5redefine_choice.adoc b/tests/docs/no_namespace/16_5redefine_choice.adoc index 6aa909f..c423533 100644 --- a/tests/docs/no_namespace/16_5redefine_choice.adoc +++ b/tests/docs/no_namespace/16_5redefine_choice.adoc @@ -23,29 +23,17 @@ variable: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A variable. + -**Choices**: +**Choix**: * a -* b +* b |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: a_choice ----- -== Example with all variables modifiable - -[,yaml] ----- -variable: a_choice ----- diff --git a/tests/docs/no_namespace/16_5redefine_choice.md b/tests/docs/no_namespace/16_5redefine_choice.md index d9cd950..b581363 100644 --- a/tests/docs/no_namespace/16_5redefine_choice.md +++ b/tests/docs/no_namespace/16_5redefine_choice.md @@ -27,20 +27,8 @@ variable: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable.
**Choix**:
- a
- b | -# Example with mandatory variables not filled in - -```yaml ---- -variable: a_choice -``` -# Example with all variables modifiable - -```yaml ---- -variable: a_choice -``` diff --git a/tests/docs/no_namespace/16_5redefine_default.adoc b/tests/docs/no_namespace/16_5redefine_default.adoc index 24086f6..f652365 100644 --- a/tests/docs/no_namespace/16_5redefine_default.adoc +++ b/tests/docs/no_namespace/16_5redefine_default.adoc @@ -18,20 +18,14 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: yes ----- diff --git a/tests/docs/no_namespace/16_5redefine_default.md b/tests/docs/no_namespace/16_5redefine_default.md index 30f4687..d81d7a3 100644 --- a/tests/docs/no_namespace/16_5redefine_default.md +++ b/tests/docs/no_namespace/16_5redefine_default.md @@ -22,14 +22,8 @@ variable: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -variable: yes -``` diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc index 29d3b64..64b400d 100644 --- a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc @@ -15,30 +15,17 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: yes ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -variable: example ----- diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.md b/tests/docs/no_namespace/16_5redefine_default_calculation.md index a16e7c8..55a688e 100644 --- a/tests/docs/no_namespace/16_5redefine_default_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.md @@ -19,25 +19,12 @@ version: '1.1' variable: description: a variable default: - type: jinja jinja: yes ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -variable: example -``` diff --git a/tests/docs/no_namespace/16_5redefine_family.adoc b/tests/docs/no_namespace/16_5redefine_family.adoc index 0cdca34..738ec57 100644 --- a/tests/docs/no_namespace/16_5redefine_family.adoc +++ b/tests/docs/no_namespace/16_5redefine_family.adoc @@ -21,27 +21,13 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - variable: example ----- diff --git a/tests/docs/no_namespace/16_5redefine_family.md b/tests/docs/no_namespace/16_5redefine_family.md index bc60018..a767e69 100644 --- a/tests/docs/no_namespace/16_5redefine_family.md +++ b/tests/docs/no_namespace/16_5redefine_family.md @@ -25,22 +25,8 @@ family: # a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - variable: example -``` diff --git a/tests/docs/no_namespace/16_5redefine_help.adoc b/tests/docs/no_namespace/16_5redefine_help.adoc index 4641242..2e55488 100644 --- a/tests/docs/no_namespace/16_5redefine_help.adoc +++ b/tests/docs/no_namespace/16_5redefine_help.adoc @@ -31,28 +31,14 @@ family: Redefine help family ok. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | Redefine help. + -Redefine help ok. +Redefine help ok. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - variable: example ----- diff --git a/tests/docs/no_namespace/16_5redefine_help.md b/tests/docs/no_namespace/16_5redefine_help.md index fa5ab77..1bb1ad4 100644 --- a/tests/docs/no_namespace/16_5redefine_help.md +++ b/tests/docs/no_namespace/16_5redefine_help.md @@ -35,22 +35,8 @@ family: Redefine help family ok. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefine help.
Redefine help ok. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Redefine help.
Redefine help ok. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - variable: example -``` diff --git a/tests/docs/no_namespace/16_5redefine_hidden.adoc b/tests/docs/no_namespace/16_5redefine_hidden.adoc index e484541..e6861a6 100644 --- a/tests/docs/no_namespace/16_5redefine_hidden.adoc +++ b/tests/docs/no_namespace/16_5redefine_hidden.adoc @@ -13,4 +13,5 @@ version: '1.1' variable: redefine: true hidden: true + mandatory: false ---- diff --git a/tests/docs/no_namespace/16_5redefine_hidden.md b/tests/docs/no_namespace/16_5redefine_hidden.md index d0b8ac8..6233386 100644 --- a/tests/docs/no_namespace/16_5redefine_hidden.md +++ b/tests/docs/no_namespace/16_5redefine_hidden.md @@ -17,4 +17,5 @@ version: '1.1' variable: redefine: true hidden: true + mandatory: false ``` diff --git a/tests/docs/no_namespace/16_5redefine_multi.adoc b/tests/docs/no_namespace/16_5redefine_multi.adoc index ad2e1d9..e68e9f5 100644 --- a/tests/docs/no_namespace/16_5redefine_multi.adoc +++ b/tests/docs/no_namespace/16_5redefine_multi.adoc @@ -20,23 +20,16 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="130a,130a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A variable. + -**Default**: +**Défaut**: -* non +* non |==== -== Example with all variables modifiable - -[,yaml] ----- -variable: - - non ----- diff --git a/tests/docs/no_namespace/16_5redefine_multi.md b/tests/docs/no_namespace/16_5redefine_multi.md index 82dd331..b0999bd 100644 --- a/tests/docs/no_namespace/16_5redefine_multi.md +++ b/tests/docs/no_namespace/16_5redefine_multi.md @@ -24,15 +24,8 @@ variable: ``` # Variables -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**:
- non | +| Variable                                                                                                                         | Description                                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A variable.
**Défaut**:
- non | -# Example with all variables modifiable - -```yaml ---- -variable: - - non -``` diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc index b5058de..833ff72 100644 --- a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc @@ -16,7 +16,6 @@ condition: no # a condition variable: description: a variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} true @@ -26,31 +25,18 @@ variable: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: no -variable: example ----- diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md index 88dcc60..f8f75f9 100644 --- a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.md @@ -20,7 +20,6 @@ condition: no # a condition variable: description: a variable disabled: - type: jinja jinja: | {% if _.condition == "yes" %} true @@ -30,22 +29,9 @@ variable: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: no -variable: example -``` diff --git a/tests/docs/no_namespace/16_5test_redefine.adoc b/tests/docs/no_namespace/16_5test_redefine.adoc index 8976aeb..c0944c4 100644 --- a/tests/docs/no_namespace/16_5test_redefine.adoc +++ b/tests/docs/no_namespace/16_5test_redefine.adoc @@ -33,41 +33,25 @@ var3: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no + -**Example**: test1 +**Défaut**: no + +**Exemple**: test1 | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: non + -**Example**: test1 +**Défaut**: non + +**Exemple**: test1 | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A third variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A third variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var1: test1 -var2: test1 -var3: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: test1 -var2: test1 -var3: example ----- diff --git a/tests/docs/no_namespace/16_5test_redefine.md b/tests/docs/no_namespace/16_5test_redefine.md index fcf35ab..61479bd 100644 --- a/tests/docs/no_namespace/16_5test_redefine.md +++ b/tests/docs/no_namespace/16_5test_redefine.md @@ -37,26 +37,10 @@ var3: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no
**Example**: test1 | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: non
**Example**: test1 | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A third variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no
**Exemple**: test1 | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: non
**Exemple**: test1 | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A third variable. | -# Example with mandatory variables not filled in - -```yaml ---- -var1: test1 -var2: test1 -var3: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: test1 -var2: test1 -var3: example -``` diff --git a/tests/docs/no_namespace/16_6choice_redefine.adoc b/tests/docs/no_namespace/16_6choice_redefine.adoc index 0a0aec1..512ecfc 100644 --- a/tests/docs/no_namespace/16_6choice_redefine.adoc +++ b/tests/docs/no_namespace/16_6choice_redefine.adoc @@ -25,23 +25,17 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `obligatoire` | A choice. + -**Choices**: +**Choix**: * a -* c ← (default) +* c ← (defaut) |==== -== Example with all variables modifiable - -[,yaml] ----- -var: c ----- diff --git a/tests/docs/no_namespace/16_6choice_redefine.md b/tests/docs/no_namespace/16_6choice_redefine.md index 725e191..f7819a6 100644 --- a/tests/docs/no_namespace/16_6choice_redefine.md +++ b/tests/docs/no_namespace/16_6choice_redefine.md @@ -29,14 +29,8 @@ var: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A choice.
**Choix**:
- a
- c ← (defaut) | -# Example with all variables modifiable - -```yaml ---- -var: c -``` diff --git a/tests/docs/no_namespace/16exists_exists.adoc b/tests/docs/no_namespace/16exists_exists.adoc index 17f3980..385a85f 100644 --- a/tests/docs/no_namespace/16exists_exists.adoc +++ b/tests/docs/no_namespace/16exists_exists.adoc @@ -17,25 +17,13 @@ var: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Description. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Description. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: example ----- diff --git a/tests/docs/no_namespace/16exists_exists.md b/tests/docs/no_namespace/16exists_exists.md index fc8dadb..2a7fabb 100644 --- a/tests/docs/no_namespace/16exists_exists.md +++ b/tests/docs/no_namespace/16exists_exists.md @@ -21,20 +21,8 @@ var: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Description. | -# Example with mandatory variables not filled in - -```yaml ---- -var: example -``` -# Example with all variables modifiable - -```yaml ---- -var: example -``` diff --git a/tests/docs/no_namespace/17_5redefine_leadership.adoc b/tests/docs/no_namespace/17_5redefine_leadership.adoc index 3e7fb3c..8b41cc5 100644 --- a/tests/docs/no_namespace/17_5redefine_leadership.adoc +++ b/tests/docs/no_namespace/17_5redefine_leadership.adoc @@ -14,6 +14,11 @@ leader: version: '1.1' leader: # a leadership type: leadership - leader: [] # a leader - follower: # a follower + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/no_namespace/17_5redefine_leadership.md b/tests/docs/no_namespace/17_5redefine_leadership.md index 6890c87..58d32e4 100644 --- a/tests/docs/no_namespace/17_5redefine_leadership.md +++ b/tests/docs/no_namespace/17_5redefine_leadership.md @@ -18,6 +18,11 @@ leader: version: '1.1' leader: # a leadership type: leadership - leader: [] # a leader - follower: # a follower + leader: + description: a leader + multi: true + mandatory: false + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/no_namespace/20_0family_append.adoc b/tests/docs/no_namespace/20_0family_append.adoc index 3c6ff44..f07f320 100644 --- a/tests/docs/no_namespace/20_0family_append.adoc +++ b/tests/docs/no_namespace/20_0family_append.adoc @@ -23,33 +23,17 @@ family: `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The first variable. | **family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The second variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - var1: example - var2: example ----- diff --git a/tests/docs/no_namespace/20_0family_append.md b/tests/docs/no_namespace/20_0family_append.md index d42dd82..2f83e29 100644 --- a/tests/docs/no_namespace/20_0family_append.md +++ b/tests/docs/no_namespace/20_0family_append.md @@ -27,25 +27,9 @@ family: `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | -| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The first variable. | +| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The second variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - var1: example - var2: example -``` diff --git a/tests/docs/no_namespace/20_0family_underscore.adoc b/tests/docs/no_namespace/20_0family_underscore.adoc index d7798d8..e18f2fd 100644 --- a/tests/docs/no_namespace/20_0family_underscore.adoc +++ b/tests/docs/no_namespace/20_0family_underscore.adoc @@ -7,20 +7,23 @@ my_family: _type: family _description: This is a great family _help: This is a great family - _mode: basic + _mode: standard _hidden: true _disabled: true type: description: a type family type: family my_variable: + mandatory: false description: description: This is a other great family my_variable: + mandatory: false help: description: a help family help: This is a other great family my_variable: + mandatory: false mode: description: a mode family mode: advanced @@ -30,8 +33,10 @@ my_family: description: an hidden family hidden: true my_variable: + mandatory: false disabled: description: an disabled family disabled: true my_variable: + mandatory: false ---- diff --git a/tests/docs/no_namespace/20_0family_underscore.md b/tests/docs/no_namespace/20_0family_underscore.md index c580bd7..f75a46e 100644 --- a/tests/docs/no_namespace/20_0family_underscore.md +++ b/tests/docs/no_namespace/20_0family_underscore.md @@ -11,20 +11,23 @@ my_family: _type: family _description: This is a great family _help: This is a great family - _mode: basic + _mode: standard _hidden: true _disabled: true type: description: a type family type: family my_variable: + mandatory: false description: description: This is a other great family my_variable: + mandatory: false help: description: a help family help: This is a other great family my_variable: + mandatory: false mode: description: a mode family mode: advanced @@ -34,8 +37,10 @@ my_family: description: an hidden family hidden: true my_variable: + mandatory: false disabled: description: an disabled family disabled: true my_variable: + mandatory: false ``` diff --git a/tests/docs/no_namespace/20_0multi_family.adoc b/tests/docs/no_namespace/20_0multi_family.adoc index 9018569..d035b88 100644 --- a/tests/docs/no_namespace/20_0multi_family.adoc +++ b/tests/docs/no_namespace/20_0multi_family.adoc @@ -29,11 +29,3 @@ A variable. |==== -== Example with all variables modifiable - -[,yaml] ----- -family: - subfamily: - variable: example ----- diff --git a/tests/docs/no_namespace/20_0multi_family.md b/tests/docs/no_namespace/20_0multi_family.md index d1a0489..d0f976b 100644 --- a/tests/docs/no_namespace/20_0multi_family.md +++ b/tests/docs/no_namespace/20_0multi_family.md @@ -28,11 +28,3 @@ family: # a family | **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | -# Example with all variables modifiable - -```yaml ---- -family: - subfamily: - variable: example -``` diff --git a/tests/docs/no_namespace/20_0multi_family_basic.adoc b/tests/docs/no_namespace/20_0multi_family_basic.adoc index 094c6f1..ea3b218 100644 --- a/tests/docs/no_namespace/20_0multi_family_basic.adoc +++ b/tests/docs/no_namespace/20_0multi_family_basic.adoc @@ -17,29 +17,13 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - subfamily: - variable: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - subfamily: - variable: example ----- diff --git a/tests/docs/no_namespace/20_0multi_family_basic.md b/tests/docs/no_namespace/20_0multi_family_basic.md index c9221c3..15fd687 100644 --- a/tests/docs/no_namespace/20_0multi_family_basic.md +++ b/tests/docs/no_namespace/20_0multi_family_basic.md @@ -21,24 +21,8 @@ family: # a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - subfamily: - variable: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - subfamily: - variable: example -``` diff --git a/tests/docs/no_namespace/20_0multi_family_order.adoc b/tests/docs/no_namespace/20_0multi_family_order.adoc index 34273bd..a56bf22 100644 --- a/tests/docs/no_namespace/20_0multi_family_order.adoc +++ b/tests/docs/no_namespace/20_0multi_family_order.adoc @@ -12,70 +12,48 @@ family: # a family ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== === a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. |==== ==== a sub family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.subfamily.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.variable2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A second variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A second variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -variable: example -family: - variable1: example - subfamily: - variable: example - variable2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -variable: example -family: - variable1: example - subfamily: - variable: example - variable2: example ----- diff --git a/tests/docs/no_namespace/20_0multi_family_order.md b/tests/docs/no_namespace/20_0multi_family_order.md index bbe7ae7..ec861b3 100644 --- a/tests/docs/no_namespace/20_0multi_family_order.md +++ b/tests/docs/no_namespace/20_0multi_family_order.md @@ -16,50 +16,28 @@ family: # a family ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | ## a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | ### a sub family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A second variable. | -# Example with mandatory variables not filled in - -```yaml ---- -variable: example -family: - variable1: example - subfamily: - variable: example - variable2: example -``` -# Example with all variables modifiable - -```yaml ---- -variable: example -family: - variable1: example - subfamily: - variable: example - variable2: example -``` diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc index a40633a..3e25a34 100644 --- a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc @@ -6,8 +6,7 @@ version: '1.1' var3: redefine: true validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var2 %} var3 must be different than var2 {% endif %} @@ -23,9 +22,10 @@ var2: no # a second variable var3: description: a third variable default: yes + test: + - yes validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var1 %} var3 must be different than var1 {% endif %} @@ -33,33 +33,26 @@ var3: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A first variable. + -**Default**: no +**Défaut**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A third variable. + **Validator**: var3 must be different than var2. + -**Default**: yes +**Défaut**: yes + +**Exemple**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: no -var2: no -var3: yes ----- diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.md b/tests/docs/no_namespace/20_0validators_differ_redefine.md index 1850700..3da4ebd 100644 --- a/tests/docs/no_namespace/20_0validators_differ_redefine.md +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.md @@ -10,8 +10,7 @@ version: '1.1' var3: redefine: true validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var2 %} var3 must be different than var2 {% endif %} @@ -27,9 +26,10 @@ var2: no # a second variable var3: description: a third variable default: yes + test: + - yes validators: - - type: jinja - jinja: | + - jinja: | {% if _.var3 == _.var1 %} var3 must be different than var1 {% endif %} @@ -37,18 +37,10 @@ var3: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Validator**: var3 must be different than var2.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A first variable.
**Défaut**: no | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Validator**: var3 must be different than var2.
**Défaut**: yes
**Exemple**: yes | -# Example with all variables modifiable - -```yaml ---- -var1: no -var2: no -var3: yes -``` diff --git a/tests/docs/no_namespace/20_9default_information_parent.adoc b/tests/docs/no_namespace/20_9default_information_parent.adoc index 50ef944..faef2b9 100644 --- a/tests/docs/no_namespace/20_9default_information_parent.adoc +++ b/tests/docs/no_namespace/20_9default_information_parent.adoc @@ -18,34 +18,18 @@ family: `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A first variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A first variable. | **family.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: value of the information. +**Défaut**: la valeur de information. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - var1: example - var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -family: - var1: example - var2: example ----- diff --git a/tests/docs/no_namespace/20_9default_information_parent.md b/tests/docs/no_namespace/20_9default_information_parent.md index 4ec941c..6b01ef8 100644 --- a/tests/docs/no_namespace/20_9default_information_parent.md +++ b/tests/docs/no_namespace/20_9default_information_parent.md @@ -22,25 +22,9 @@ family: `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A first variable. | -| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: value of the information. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A first variable. | +| **family.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: la valeur de information. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - var1: example - var2: example -``` -# Example with all variables modifiable - -```yaml ---- -family: - var1: example - var2: example -``` diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc index b981128..c519204 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc @@ -7,7 +7,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -18,50 +17,33 @@ family: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The variable use has condition. + -**Default**: no +**Défaut**: no |==== === possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ==== family.subfamily `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - subfamily: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: no -family: - subfamily: - var1: example ----- diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md index 8f33b85..efbfd76 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md @@ -11,7 +11,6 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -22,39 +21,22 @@ family: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: no | ## possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ### family.subfamily `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - subfamily: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: no -family: - subfamily: - var1: example -``` diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc index 2f8ef18..f787f9b 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc @@ -7,57 +7,41 @@ condition: true # the variable use has condition family: description: possibly hidden family hidden: - type: variable variable: _.condition subfamily: # a subfamily - var1: # a variable + var1: + description: a variable + mandatory: false ---- == Variables -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | The variable use has condition. + -**Default**: True +**Défaut**: True |==== === possibly hidden family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: when the variable "condition" has the value "True". +**Caché**: when the variable "condition" has the value "True". ==== a subfamily -`basic` +`standard` -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.subfamily.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - subfamily: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: true -family: - subfamily: - var1: example ----- diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md index 378ea08..068475a 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md @@ -11,46 +11,30 @@ condition: true # the variable use has condition family: description: possibly hidden family hidden: - type: variable variable: _.condition subfamily: # a subfamily - var1: # a variable + var1: + description: a variable + mandatory: false ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: True | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: True | ## possibly hidden family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: when the variable "condition" has the value "True". +**Caché**: when the variable "condition" has the value "True". ### a subfamily -`basic` +`standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - subfamily: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: true -family: - subfamily: - var1: example -``` diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc index 660b9bf..2305a03 100644 --- a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc @@ -7,14 +7,12 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if condition == "yes" %} condition is yes {% endif %} params: condition: - type: variable variable: _.condition description: if condition is yes sub_family: # a subfamily @@ -22,50 +20,33 @@ family: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | The variable use has condition. + -**Default**: no +**Défaut**: no |==== === possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ==== a subfamily `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.sub_family.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -family: - sub_family: - var1: example ----- -== Example with all variables modifiable - -[,yaml] ----- -condition: no -family: - sub_family: - var1: example ----- diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md index f44239c..e4bf6e5 100644 --- a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md @@ -11,14 +11,12 @@ condition: no # the variable use has condition family: description: possibly hidden family hidden: - type: jinja jinja: | {% if condition == "yes" %} condition is yes {% endif %} params: condition: - type: variable variable: _.condition description: if condition is yes sub_family: # a subfamily @@ -26,39 +24,22 @@ family: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | The variable use has condition.
**Défaut**: no | ## possibly hidden family -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is yes. +**Caché**: if condition is yes. ### a subfamily `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable. | -# Example with mandatory variables not filled in - -```yaml ---- -family: - sub_family: - var1: example -``` -# Example with all variables modifiable - -```yaml ---- -condition: no -family: - sub_family: - var1: example -``` diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc index d138eb9..1258be6 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc @@ -7,7 +7,6 @@ condition: no # a condition var: description: a variable mandatory: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -16,26 +15,19 @@ var: ---- == Variables -[cols="110a,110a",options="header"] +[cols="112a,112a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`obligatoire`_ | A variable. + -**Mandatory**: only if rougail.condition has the value "yes". +**Obligatoire**: only if rougail.condition has the value "yes". |==== -== Example with all variables modifiable - -[,yaml] ----- -condition: no -var: example ----- diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.md b/tests/docs/no_namespace/24_0family_mandatory_condition.md index 27137f1..82aed6d 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.md @@ -11,7 +11,6 @@ condition: no # a condition var: description: a variable mandatory: - type: jinja jinja: | {% if _.condition == "yes" %} condition is yes @@ -20,16 +19,9 @@ var: ``` # Variables -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`obligatoire`_ | A variable.
**Obligatoire**: only if rougail.condition has the value "yes". | -# Example with all variables modifiable - -```yaml ---- -condition: no -var: example -``` diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc index fd529c5..aa03719 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc @@ -7,31 +7,23 @@ condition: true # a condition var: description: a variable mandatory: - type: variable variable: _.condition ---- == Variables -[cols="110a,110a",options="header"] +[cols="112a,112a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A condition. + -**Default**: True +**Défaut**: True | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`obligatoire`_ | A variable. + -**Mandatory**: when the variable "condition" has the value "True". +**Obligatoire**: when the variable "condition" has the value "True". |==== -== Example with all variables modifiable - -[,yaml] ----- -condition: true -var: example ----- diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md index f096394..6baba97 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md @@ -11,21 +11,13 @@ condition: true # a condition var: description: a variable mandatory: - type: variable variable: _.condition ``` # Variables -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: when the variable "condition" has the value "True". | +| Variable                                                                                                       | Description                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: True | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`obligatoire`_ | A variable.
**Obligatoire**: when the variable "condition" has the value "True". | -# Example with all variables modifiable - -```yaml ---- -condition: true -var: example -``` diff --git a/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc b/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc new file mode 100644 index 0000000..fc4f78b --- /dev/null +++ b/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc @@ -0,0 +1,16 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +---- diff --git a/tests/docs/no_namespace/24_family_disabled_var_hidden.md b/tests/docs/no_namespace/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..05c7bbb --- /dev/null +++ b/tests/docs/no_namespace/24_family_disabled_var_hidden.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: 1.1 + +family: + disabled: true + + var1: true # A description + + var2: + description: A description + hidden: + variable: _.var1 +``` diff --git a/tests/docs/no_namespace/40_0leadership.adoc b/tests/docs/no_namespace/40_0leadership.adoc index 490737f..22d8d9e 100644 --- a/tests/docs/no_namespace/40_0leadership.adoc +++ b/tests/docs/no_namespace/40_0leadership.adoc @@ -3,13 +3,19 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader - multi: true + test: + - val1 + - val2 + follower1: # a follower + follower2: # an other follower ---- == Variables @@ -21,30 +27,25 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. + +**Exemples**: + +* val1 +* val2 | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. | **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +An other follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/no_namespace/40_0leadership.md b/tests/docs/no_namespace/40_0leadership.md index 455d63f..ae4472d 100644 --- a/tests/docs/no_namespace/40_0leadership.md +++ b/tests/docs/no_namespace/40_0leadership.md @@ -7,13 +7,19 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader - multi: true + test: + - val1 + - val2 + follower1: # a follower + follower2: # an other follower ``` # Variables @@ -25,19 +31,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader.
**Exemples**:
- val1
- val2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | An other follower. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.adoc b/tests/docs/no_namespace/40_0leadership_diff_name.adoc index cc45b83..c63f9d8 100644 --- a/tests/docs/no_namespace/40_0leadership_diff_name.adoc +++ b/tests/docs/no_namespace/40_0leadership_diff_name.adoc @@ -19,30 +19,21 @@ leadership: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. | **leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -An other follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +An other follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -leadership: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.md b/tests/docs/no_namespace/40_0leadership_diff_name.md index 3512e7a..092a056 100644 --- a/tests/docs/no_namespace/40_0leadership_diff_name.md +++ b/tests/docs/no_namespace/40_0leadership_diff_name.md @@ -23,19 +23,10 @@ leadership: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | -| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An other follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | An other follower. | -# Example with all variables modifiable - -```yaml ---- -leadership: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc index 50c21a2..5721a3b 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc @@ -11,7 +11,6 @@ leader: follower2: description: a second follower default: - type: jinja jinja: | {{ _.follower1 }} description: returns follower1 value @@ -25,32 +24,23 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A follower. + -**Default**: value +**Défaut**: value | **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second follower. + -**Default**: returns follower1 value. +**Défaut**: returns follower1 value. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: value - follower2: value ----- diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md index 31b1a23..9292999 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.md @@ -15,7 +15,6 @@ leader: follower2: description: a second follower default: - type: jinja jinja: | {{ _.follower1 }} description: returns follower1 value @@ -29,19 +28,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: value | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second follower.
**Default**: returns follower1 value. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower.
**Défaut**: value | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second follower.
**Défaut**: returns follower1 value. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: value - follower2: value -``` diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc index 7504dba..0b4e719 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc @@ -21,26 +21,18 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A follower with default value. + -**Default**: value +**Défaut**: value |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: value ----- diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.md b/tests/docs/no_namespace/40_0leadership_follower_default_value.md index 90f5810..2e70810 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_value.md +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.md @@ -25,17 +25,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower with default value.
**Default**: value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A follower with default value.
**Défaut**: value | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: value -``` diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc new file mode 100644 index 0000000..7ffbc0c --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc @@ -0,0 +1,69 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +---- +== Variables + +=== general + +`standard` + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**general.mode_conteneur_actif** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | +No change. + +**Défaut**: non +|==== + +=== general1 + +`basic` + +==== general1.leader + +`basic` + + +This family contains lists of variable blocks. + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**general1.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +Leader. +| +**general1.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Follower1. +| +**general1.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +Follower2. +|==== + + diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.md b/tests/docs/no_namespace/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..67fe7f3 --- /dev/null +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +general: + mode_conteneur_actif: + type: string + description: No change + default: non +general1: + leader: + description: leader + type: leadership + leader: + type: string + description: leader + follower1: + type: string + description: follower1 + follower2: + type: string + description: follower2 +version: '1.0' +``` +# Variables + +## general + +`standard` + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | No change.
**Défaut**: non | + +## general1 + +`basic` + +### general1.leader + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | Leader. | +| **general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Follower1. | +| **general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | Follower2. | + + diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.adoc b/tests/docs/no_namespace/40_1leadership_append_follower.adoc index f7f81a1..18a7de8 100644 --- a/tests/docs/no_namespace/40_1leadership_append_follower.adoc +++ b/tests/docs/no_namespace/40_1leadership_append_follower.adoc @@ -32,35 +32,25 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The leader. | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower1. | **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower2. | **leader.follower3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -The follower3. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +The follower3. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: example - follower2: example - follower3: example ----- diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.md b/tests/docs/no_namespace/40_1leadership_append_follower.md index 26e9c97..919dec7 100644 --- a/tests/docs/no_namespace/40_1leadership_append_follower.md +++ b/tests/docs/no_namespace/40_1leadership_append_follower.md @@ -36,21 +36,11 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower1. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower2. | -| **leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The follower3. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower2. | +| **leader.follower3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | The follower3. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: example - follower2: example - follower3: example -``` diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc index 0b6f19e..196729c 100644 --- a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc @@ -27,35 +27,24 @@ leadership: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +The leader. | **leadership.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | -The first follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `multiple` | +The first follower. | **leadership.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `multiple` | The second follower. + -**Default**: +**Défaut**: -* value +* value |==== -== Example with all variables modifiable - -[,yaml] ----- -leadership: - - leader: example - follower1: - - example - follower2: - - value ----- diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.md b/tests/docs/no_namespace/40_6leadership_follower_multi.md index 55b3433..821cd51 100644 --- a/tests/docs/no_namespace/40_6leadership_follower_multi.md +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.md @@ -31,21 +31,10 @@ leadership: This family contains lists of variable blocks. -| Variable                                                                                                              | Description                                                                                                           | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The leader. | -| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `multiple` | The first follower. | -| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | The second follower.
**Default**:
- value | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | The leader. | +| **leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `multiple` | The first follower. | +| **leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `multiple` | The second follower.
**Défaut**:
- value | -# Example with all variables modifiable - -```yaml ---- -leadership: - - leader: example - follower1: - - example - follower2: - - value -``` diff --git a/tests/docs/no_namespace/40_8calculation_boolean.adoc b/tests/docs/no_namespace/40_8calculation_boolean.adoc index 7dff654..6ee2499 100644 --- a/tests/docs/no_namespace/40_8calculation_boolean.adoc +++ b/tests/docs/no_namespace/40_8calculation_boolean.adoc @@ -9,7 +9,6 @@ multi1: type: boolean multi: true default: - type: jinja jinja: | {% if _.bool %} True @@ -23,7 +22,6 @@ multi2: type: boolean multi: true default: - type: jinja jinja: | {% if not _.bool %} True @@ -35,35 +33,24 @@ multi2: ---- == Variables -[cols="129a,129a",options="header"] +[cols="131a,131a",options="header"] |==== -| Variable | Description +| Variable | Description | **bool** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` | A boolean variable. + -**Default**: False +**Défaut**: False | **multi1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | A first multi variable. + -**Default**: a calculation. +**Défaut**: a calculation. | **multi2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `obligatoire` `unique` `multiple` | A second multi variable. + -**Default**: a calculation. +**Défaut**: a calculation. |==== -== Example with all variables modifiable - -[,yaml] ----- -bool: false -multi1: - - false -multi2: - - true - - false ----- diff --git a/tests/docs/no_namespace/40_8calculation_boolean.md b/tests/docs/no_namespace/40_8calculation_boolean.md index d4ce4ae..a9d271d 100644 --- a/tests/docs/no_namespace/40_8calculation_boolean.md +++ b/tests/docs/no_namespace/40_8calculation_boolean.md @@ -13,7 +13,6 @@ multi1: type: boolean multi: true default: - type: jinja jinja: | {% if _.bool %} True @@ -27,7 +26,6 @@ multi2: type: boolean multi: true default: - type: jinja jinja: | {% if not _.bool %} True @@ -39,21 +37,10 @@ multi2: ``` # Variables -| Variable                                                                                                                        | Description                                                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A boolean variable.
**Default**: False | -| **multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first multi variable.
**Default**: a calculation. | -| **multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second multi variable.
**Default**: a calculation. | +| Variable                                                                                                                          | Description                                                                                                                       | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **bool**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A boolean variable.
**Défaut**: False | +| **multi1**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first multi variable.
**Défaut**: a calculation. | +| **multi2**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A second multi variable.
**Défaut**: a calculation. | -# Example with all variables modifiable - -```yaml ---- -bool: false -multi1: - - false -multi2: - - true - - false -``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc index 6255773..daf95af 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc @@ -6,46 +6,34 @@ version: '1.1' var: description: a first variable default: - - type: variable - variable: _.var2 - - type: variable - variable: _.var3 + - variable: _.var2 + - variable: _.var3 var2: no # a second variable var3: yes # a third variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A first variable. + -**Default**: +**Défaut**: -* the value of the variable "var2". -* the value of the variable "var3". +* la valeur de la variable "var2". +* la valeur de la variable "var3". | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: no +**Défaut**: no | **var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A third variable. + -**Default**: yes +**Défaut**: yes |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - no - - yes -var2: no -var3: yes ----- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.md b/tests/docs/no_namespace/40_8calculation_multi_variable.md index 66f4fc8..a987654 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.md @@ -10,29 +10,17 @@ version: '1.1' var: description: a first variable default: - - type: variable - variable: _.var2 - - type: variable - variable: _.var3 + - variable: _.var2 + - variable: _.var3 var2: no # a second variable var3: yes # a third variable ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A first variable.
**Default**:
- the value of the variable "var2".
- the value of the variable "var3". | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | -| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: yes | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A first variable.
**Défaut**:
- la valeur de la variable "var2".
- la valeur de la variable "var3". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: no | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A third variable.
**Défaut**: yes | -# Example with all variables modifiable - -```yaml ---- -var: - - no - - yes -var2: no -var3: yes -``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc index 1332d37..37aaf8c 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc @@ -8,41 +8,32 @@ fam1: # a family var: description: a calculated variable default: - type: variable variable: __.var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no |==== === a family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A calculated variable. + -**Default**: the value of the variable "var". +**Défaut**: la valeur de la variable "var". |==== -== Example with all variables modifiable - -[,yaml] ----- -var: no -fam1: - var: no ----- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md index 4899bfd..6ab9ac4 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.md @@ -12,29 +12,20 @@ fam1: # a family var: description: a calculated variable default: - type: variable variable: __.var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | ## a family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: the value of the variable "var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A calculated variable.
**Défaut**: la valeur de la variable "var". | -# Example with all variables modifiable - -```yaml ---- -var: no -fam1: - var: no -``` diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc index 64f54ae..17acbd0 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc @@ -9,7 +9,6 @@ fam2: # second family var: description: a varaible default: - type: variable variable: __.fam1.var ---- == Variables @@ -18,37 +17,28 @@ fam2: # second family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **fam1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: no +**Défaut**: no |==== === second family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **fam2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A varaible. + -**Default**: the value of the variable "fam1.var". +**Défaut**: la valeur de la variable "fam1.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -fam1: - var: no -fam2: - var: no ----- diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md index 3b72c52..4bae58d 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.md @@ -13,7 +13,6 @@ fam2: # second family var: description: a varaible default: - type: variable variable: __.fam1.var ``` # Variables @@ -22,25 +21,16 @@ fam2: # second family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: no | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: no | ## second family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varaible.
**Default**: the value of the variable "fam1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A varaible.
**Défaut**: la valeur de la variable "fam1.var". | -# Example with all variables modifiable - -```yaml ---- -fam1: - var: no -fam2: - var: no -``` diff --git a/tests/docs/no_namespace/41_0choice_leader.adoc b/tests/docs/no_namespace/41_0choice_leader.adoc index da5f0af..708f106 100644 --- a/tests/docs/no_namespace/41_0choice_leader.adoc +++ b/tests/docs/no_namespace/41_0choice_leader.adoc @@ -27,30 +27,22 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -The leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +The leader. | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `obligatoire` | A follower. + -**Choices**: +**Choix**: * a * b -* c +* c |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: a_choice ----- diff --git a/tests/docs/no_namespace/41_0choice_leader.md b/tests/docs/no_namespace/41_0choice_leader.md index ef05258..cb132a1 100644 --- a/tests/docs/no_namespace/41_0choice_leader.md +++ b/tests/docs/no_namespace/41_0choice_leader.md @@ -31,17 +31,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | -| **leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower.
**Choices**:
- a
- b
- c | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | The leader. | +| **leader.follower1**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower.
**Choix**:
- a
- b
- c | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: a_choice -``` diff --git a/tests/docs/no_namespace/44_0leadership_hidden.adoc b/tests/docs/no_namespace/44_0leadership_hidden.adoc index 0045864..6035ae2 100644 --- a/tests/docs/no_namespace/44_0leadership_hidden.adoc +++ b/tests/docs/no_namespace/44_0leadership_hidden.adoc @@ -3,10 +3,17 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership hidden: true type: leadership - leader: [] # a leader - follower: # a follower + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/no_namespace/44_0leadership_hidden.md b/tests/docs/no_namespace/44_0leadership_hidden.md index 32576ab..626b112 100644 --- a/tests/docs/no_namespace/44_0leadership_hidden.md +++ b/tests/docs/no_namespace/44_0leadership_hidden.md @@ -7,10 +7,17 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership hidden: true type: leadership - leader: [] # a leader - follower: # a follower + + leader: + description: a leader + mandatory: false + + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc index ab771fc..fbd2146 100644 --- a/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc @@ -3,12 +3,18 @@ [,yaml] ---- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true hidden: true - follower: # a follower + mandatory: false + + follower: + description: a follower + mandatory: false ---- diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.md b/tests/docs/no_namespace/44_0leadership_leader_hidden.md index 252e154..a7690be 100644 --- a/tests/docs/no_namespace/44_0leadership_leader_hidden.md +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.md @@ -7,12 +7,18 @@ include_toc: true ```yaml --- version: '1.1' + leader: description: a leadership type: leadership + leader: description: a leader multi: true hidden: true - follower: # a follower + mandatory: false + + follower: + description: a follower + mandatory: false ``` diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc index d7d8d3d..ef0f10f 100644 --- a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc @@ -4,7 +4,9 @@ ---- version: '1.1' leader: - follower3: # follower3 + follower3: + description: follower3 + mandatory: false ---- == dictionaries/rougail/00-base.yml @@ -18,6 +20,11 @@ leader: description: a leader multi: true hidden: true - follower1: # the follower1 - follower2: # the follower2 + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false ---- diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md index 673d765..87edbdd 100644 --- a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.md @@ -8,7 +8,9 @@ include_toc: true --- version: '1.1' leader: - follower3: # follower3 + follower3: + description: follower3 + mandatory: false ``` # dictionaries/rougail/00-base.yml @@ -22,6 +24,11 @@ leader: description: a leader multi: true hidden: true - follower1: # the follower1 - follower2: # the follower2 + mandatory: false + follower1: + description: the follower1 + mandatory: false + follower2: + description: the follower2 + mandatory: false ``` diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.adoc b/tests/docs/no_namespace/44_4leadership_mandatory.adoc index 3dacc1b..fa8c4e4 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory.adoc @@ -28,7 +28,7 @@ This family contains lists of variable blocks. | Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | A leader. | **leader.follower1** + @@ -37,11 +37,3 @@ A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: example ----- diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.md b/tests/docs/no_namespace/44_4leadership_mandatory.md index 615f398..d430ef8 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory.md +++ b/tests/docs/no_namespace/44_4leadership_mandatory.md @@ -29,15 +29,7 @@ This family contains lists of variable blocks. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | | **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: example -``` diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc index 5bf124a..75b26c8 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc @@ -23,25 +23,17 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower: example ----- diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.md b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md index 7963eaa..577f381 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory_follower.md +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.md @@ -27,17 +27,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower: example -``` diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc index ec857fb..1a3df54 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc @@ -11,55 +11,46 @@ leader: description: a leader multi: true hidden: - type: jinja jinja: | {% if __.condition == "no" %} condition is no {% endif %} description: if condition is no + mandatory: false follower: # a follower ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: no +**Défaut**: no |==== === a leadership -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is no. +**Caché**: if condition is no. This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A leader. | **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower. |==== -== Example with all variables modifiable - -[,yaml] ----- -condition: no -leader: - - leader: example - follower: example ----- diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md index 90a342c..ab9a850 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md @@ -15,41 +15,32 @@ leader: description: a leader multi: true hidden: - type: jinja jinja: | {% if __.condition == "no" %} condition is no {% endif %} description: if condition is no + mandatory: false follower: # a follower ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: no | ## a leadership -`basic` _`hidden`_ +`basic` _`caché`_ -**Hidden**: if condition is no. +**Caché**: if condition is no. This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower. | -# Example with all variables modifiable - -```yaml ---- -condition: no -leader: - - leader: example - follower: example -``` diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc index b2f0827..6b0a734 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc @@ -13,21 +13,22 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | - {% if __.condition == "yes" %}true{% else %}false{% endif %} + {% if __.condition == "yes" %} + disabled + {% endif %} description: if condition is yes ---- == Variables -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A condition. + -**Default**: yes +**Défaut**: yes |==== === a leadership @@ -37,27 +38,18 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="121a,121a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A leader. | **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` _`désactivé`_ | A follower. + -**Disabled**: if condition is yes. +**Désactivé**: if condition is yes. |==== -== Example with all variables modifiable - -[,yaml] ----- -condition: yes -leader: - - leader: example - follower: example ----- diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md index 48fa046..f9ac19f 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md @@ -17,16 +17,17 @@ leader: follower: description: a follower disabled: - type: jinja jinja: | - {% if __.condition == "yes" %}true{% else %}false{% endif %} + {% if __.condition == "yes" %} + disabled + {% endif %} description: if condition is yes ``` # Variables -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A condition.
**Défaut**: yes | ## a leadership @@ -35,18 +36,9 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                             | Description                                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` _`désactivé`_ | A follower.
**Désactivé**: if condition is yes. | -# Example with all variables modifiable - -```yaml ---- -condition: yes -leader: - - leader: example - follower: example -``` diff --git a/tests/docs/no_namespace/60_0family_dynamic.adoc b/tests/docs/no_namespace/60_0family_dynamic.adoc index 281623a..dc95faf 100644 --- a/tests/docs/no_namespace/60_0family_dynamic.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic.adoc @@ -6,27 +6,25 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: # A dynamic variable ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -36,36 +34,15 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - var: example -dynval2: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - var: example -dynval2: - var: example ----- diff --git a/tests/docs/no_namespace/60_0family_dynamic.md b/tests/docs/no_namespace/60_0family_dynamic.md index d78a0b0..2a6b1c5 100644 --- a/tests/docs/no_namespace/60_0family_dynamic.md +++ b/tests/docs/no_namespace/60_0family_dynamic.md @@ -10,19 +10,17 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: # A dynamic variable ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -31,31 +29,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - var: example -dynval2: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - var: example -dynval2: - var: example -``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc index 516a32a..21eb53e 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc @@ -15,17 +15,17 @@ dyn: ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -35,36 +35,15 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.vardyn** ou **dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - vardyn: example -dynval2: - vardyn: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - vardyn: example -dynval2: - vardyn: example ----- diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.md b/tests/docs/no_namespace/60_0family_dynamic_1_1.md index 5f42bec..d9f4685 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_1_1.md +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.md @@ -19,9 +19,9 @@ dyn: ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -30,31 +30,10 @@ dyn: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - vardyn: example -dynval2: - vardyn: example -``` -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - vardyn: example -dynval2: - vardyn: example -``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.adoc b/tests/docs/no_namespace/60_0family_dynamic_static.adoc index d2ac21a..894a14e 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_static.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_static.adoc @@ -3,9 +3,8 @@ [,yaml] ---- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 @@ -20,36 +19,18 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 * val2 -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable inside a dynamic family. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A variable inside a dynamic family. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - var: example -dynval2: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -dynval1: - var: example -dynval2: - var: example ----- diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.md b/tests/docs/no_namespace/60_0family_dynamic_static.md index b5c7f01..7f51c90 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_static.md +++ b/tests/docs/no_namespace/60_0family_dynamic_static.md @@ -7,9 +7,8 @@ include_toc: true ```yaml --- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 @@ -24,28 +23,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**:
- val1
- val2 +**Identifiers**:
- val1
- val2 -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable inside a dynamic family. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - var: example -dynval2: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -dynval1: - var: example -dynval2: - var: example -``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.adoc b/tests/docs/no_namespace/60_0family_dynamic_test.adoc new file mode 100644 index 0000000..d1f5bee --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_test.adoc @@ -0,0 +1,54 @@ +== dictionaries/rougail/00-base.yml + +[,yaml] +---- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +---- +== Variables + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A suffix variable. + +**Exemples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "var". + +[cols="107a,107a",options="header"] +|==== +| Variable | Description +| +**dynval1.var** ou **dynval2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. +|==== + + diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.md b/tests/docs/no_namespace/60_0family_dynamic_test.md new file mode 100644 index 0000000..89b4048 --- /dev/null +++ b/tests/docs/no_namespace/60_0family_dynamic_test.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: # A dynamic variable +``` +# Variables + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A suffix variable.
**Exemples**:
- val1
- val2 | + +## A dynamic family + +`basic` + + +This family builds families dynamically. + +**Identifiers**: la valeur de la variable "var". + +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | + + diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc index fcf74cc..9076472 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc @@ -4,23 +4,21 @@ ---- version: '1.1' var: [] # a suffix variable -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | -A suffix variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | +A suffix variable. |==== === a dynamic family @@ -30,32 +28,16 @@ A suffix variable. This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynexample.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable inside dynamic family. + -**Default**: val +**Défaut**: val |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -var: - - example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: - - example -dynexample: - var: val ----- diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md index cb89f7e..e80943a 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.md @@ -8,19 +8,17 @@ include_toc: true --- version: '1.1' var: [] # a suffix variable -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: val # a variable inside dynamic family ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A suffix variable. | ## a dynamic family @@ -29,26 +27,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynexample.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable inside dynamic family.
**Défaut**: val | -# Example with mandatory variables not filled in - -```yaml ---- -var: - - example -``` -# Example with all variables modifiable - -```yaml ---- -var: - - example -dynexample: - var: val -``` diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc index 7d206e1..91c105f 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc @@ -6,27 +6,25 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - var: a value # A dynamic variable with suffix {{ suffix }} + var: a value # A dynamic variable with suffix {{ identifier }} ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -36,28 +34,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | "A dynamic variable with suffix _val1_" ou "A dynamic variable with suffix _val2_". + -**Default**: a value +**Défaut**: a value |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - var: a value -dynval2: - var: a value ----- diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md index a9e733c..7629d20 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.md @@ -10,19 +10,17 @@ version: '1.1' var: # A suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var - var: a value # A dynamic variable with suffix {{ suffix }} + var: a value # A dynamic variable with suffix {{ identifier }} ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -31,22 +29,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Default**: a value | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | "A dynamic variable with suffix *val1*" ou "A dynamic variable with suffix *val2*".
**Défaut**: a value | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - var: a value -dynval2: - var: a value -``` diff --git a/tests/docs/no_namespace/60_0family_hidden.adoc b/tests/docs/no_namespace/60_0family_hidden.adoc index 95608e1..b55cefc 100644 --- a/tests/docs/no_namespace/60_0family_hidden.adoc +++ b/tests/docs/no_namespace/60_0family_hidden.adoc @@ -13,5 +13,7 @@ family: ---- version: '1.1' family: # a family - var: # a variable + var: + description: a variable + mandatory: false ---- diff --git a/tests/docs/no_namespace/60_0family_hidden.md b/tests/docs/no_namespace/60_0family_hidden.md index 92e412b..ee44f10 100644 --- a/tests/docs/no_namespace/60_0family_hidden.md +++ b/tests/docs/no_namespace/60_0family_hidden.md @@ -17,5 +17,7 @@ family: --- version: '1.1' family: # a family - var: # a variable + var: + description: a variable + mandatory: false ``` diff --git a/tests/docs/no_namespace/60_0family_mode.adoc b/tests/docs/no_namespace/60_0family_mode.adoc index f8e70b8..0d46274 100644 --- a/tests/docs/no_namespace/60_0family_mode.adoc +++ b/tests/docs/no_namespace/60_0family_mode.adoc @@ -15,21 +15,14 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | A variable. + -**Default**: non +**Défaut**: non |==== -== Example with all variables modifiable - -[,yaml] ----- -family: - var: non ----- diff --git a/tests/docs/no_namespace/60_0family_mode.md b/tests/docs/no_namespace/60_0family_mode.md index e003606..91d346e 100644 --- a/tests/docs/no_namespace/60_0family_mode.md +++ b/tests/docs/no_namespace/60_0family_mode.md @@ -19,15 +19,8 @@ family: # a family `basic` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A variable.
**Défaut**: non | -# Example with all variables modifiable - -```yaml ---- -family: - var: non -``` diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc index 94f0850..f9fd848 100644 --- a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc @@ -6,11 +6,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: jinja jinja: | {% for val in _.var %} {{ loop.index }} @@ -20,17 +18,17 @@ dyn{{ suffix }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -40,28 +38,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: index of suffix value. +**Identifiers**: index of suffix value. -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dyn1.var** ou **dyn2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: val +**Défaut**: val |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dyn1: - var: val -dyn2: - var: val ----- diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.md b/tests/docs/no_namespace/60_1family_dynamic_jinja.md index a6f5546..327bdf9 100644 --- a/tests/docs/no_namespace/60_1family_dynamic_jinja.md +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.md @@ -10,11 +10,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: jinja jinja: | {% for val in _.var %} {{ loop.index }} @@ -24,9 +22,9 @@ dyn{{ suffix }}: ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -35,22 +33,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: index of suffix value. +**Identifiers**: index of suffix value. -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dyn1.var** ou **dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn1.var** ou **dyn2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: val | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dyn1: - var: val -dyn2: - var: val -``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc index 1723581..c433a6d 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -6,35 +6,32 @@ version: '1.1' var1: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 family: # a family var: # with a variable var2: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -44,56 +41,29 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". ==== a family `basic` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.family.var** ou **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -With a variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +With a variable. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - family: - var: example -dynval2: - family: - var: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: - - val1 - - val2 -dynval1: - family: - var: example -dynval2: - family: - var: example -var2: example ----- diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md index a23ca55..cfb9280 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.md @@ -10,27 +10,24 @@ version: '1.1' var1: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 family: # a family var: # with a variable var2: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -39,45 +36,18 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". ### a family `basic` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | With a variable. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: the value of var. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - family: - var: example -dynval2: - family: - var: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: - - val1 - - val2 -dynval1: - family: - var: example -dynval2: - family: - var: example -var2: example -``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc index ea0b451..782d221 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -3,42 +3,39 @@ [,yaml] ---- version: '1.1' -var: # a suffix variable +var: # a identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var family: description: a family inside dynamic family var: description: a dynamic variable default: - type: suffix + type: identifier var2: description: a varible outside dynamic family default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A suffix variable. + -**Default**: +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A identifier variable. + +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -48,45 +45,30 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". ==== a family inside dynamic family `standard` -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.family.var** ou **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A varible outside dynamic family. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - family: - var: val1 -dynval2: - family: - var: val2 -var2: val1 ----- diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md index 09d1edc..ec18af7 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -7,34 +7,31 @@ include_toc: true ```yaml --- version: '1.1' -var: # a suffix variable +var: # a identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var family: description: a family inside dynamic family var: description: a dynamic variable default: - type: suffix + type: identifier var2: description: a varible outside dynamic family default: - type: jinja jinja: | {{ _.dynval1.family.var }} description: the value of var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A identifier variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -43,33 +40,18 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". ### a family inside dynamic family `standard` -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: la valeur de identifier. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A varible outside dynamic family.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A varible outside dynamic family.
**Défaut**: the value of var. | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - family: - var: val1 -dynval2: - family: - var: val2 -var2: val1 -``` diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc index 2318838..7406652 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc @@ -6,34 +6,31 @@ version: '1.1' var1: # a suffx variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 var: val # a dynamic variable newvar: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.var }} description: the value of var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffx variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -43,39 +40,26 @@ A suffx variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: val +**Défaut**: val |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **newvar** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A second variable. + -**Default**: the value of var. +**Défaut**: the value of var. |==== -== Example with all variables modifiable - -[,yaml] ----- -var1: - - val1 - - val2 -dynval1: - var: val -dynval2: - var: val -newvar: val ----- diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md index f295fe9..d4f6b65 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.md @@ -10,26 +10,23 @@ version: '1.1' var1: # a suffx variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var1 var: val # a dynamic variable newvar: description: a second variable default: - type: jinja jinja: | {{ _.dynval1.var }} description: the value of var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffx variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffx variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -38,27 +35,14 @@ newvar: This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: val | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A second variable.
**Défaut**: the value of var. | -# Example with all variables modifiable - -```yaml ---- -var1: - - val1 - - val2 -dynval1: - var: val -dynval2: - var: val -newvar: val -``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc index 8cc509d..724557a 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc @@ -6,30 +6,28 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: Suffix has value default: - type: suffix + type: identifier ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -39,28 +37,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | Suffix has value. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - var: val1 -dynval2: - var: val2 ----- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md index 390638c..27a0e69 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.md @@ -10,22 +10,20 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: Suffix has value default: - type: suffix + type: identifier ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -34,22 +32,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | Suffix has value.
**Défaut**: la valeur de identifier. | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - var: val1 -dynval2: - var: val2 -``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc index b76db4e..c4761bd 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc @@ -3,39 +3,36 @@ [,yaml] ---- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable default: - type: jinja jinja: | - {{ suffix }} + {{ identifier }} params: - suffix: - type: suffix + identifier: + type: identifier description: from suffix ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A suffix variable. + -**Default**: +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | +A identifier variable. + +**Défaut**: * val1 -* val2 +* val2 |==== === A dynamic family @@ -45,28 +42,16 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A dynamic variable. + -**Default**: from suffix. +**Défaut**: from suffix. |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - var: val1 -dynval2: - var: val2 ----- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md index a0aa23d..ed8c87b 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.md @@ -7,31 +7,28 @@ include_toc: true ```yaml --- version: '1.1' -var: # A suffix variable +var: # A identifier variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: A dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: A dynamic variable default: - type: jinja jinja: | - {{ suffix }} + {{ identifier }} params: - suffix: - type: suffix + identifier: + type: identifier description: from suffix ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A identifier variable.
**Défaut**:
- val1
- val2 | ## A dynamic family @@ -40,22 +37,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A dynamic variable.
**Défaut**: from suffix. | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - var: val1 -dynval2: - var: val2 -``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc index c370d26..1572711 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc @@ -8,10 +8,8 @@ var1: default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 propertyerror: false var: @@ -19,22 +17,21 @@ dyn{{ suffix }}: var2: description: A variable calculated default: - type: variable variable: _.dynval1.var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === "dyn_val1_" ou "dyn_val2_" @@ -44,48 +41,25 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable calculated. + -**Default**: the value of the variable "dynval1.var". +**Défaut**: la valeur de la variable "dynval1.var". |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - var: example -dynval2: - var: example -var2: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var1: - - val1 - - val2 -dynval1: - var: example -dynval2: - var: example -var2: example ----- diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md index 44cb821..f069e17 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.md @@ -12,10 +12,8 @@ var1: default: - val1 - val2 -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: dynamic: - type: variable variable: _.var1 propertyerror: false var: @@ -23,14 +21,13 @@ dyn{{ suffix }}: var2: description: A variable calculated default: - type: variable variable: _.dynval1.var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## "dyn*val1*" ou "dyn*val2*" @@ -39,37 +36,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "var1". +**Identifiers**: la valeur de la variable "var1". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable calculated.
**Default**: the value of the variable "dynval1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable calculated.
**Défaut**: la valeur de la variable "dynval1.var". | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - var: example -dynval2: - var: example -var2: example -``` -# Example with all variables modifiable - -```yaml ---- -var1: - - val1 - - val2 -dynval1: - var: example -dynval2: - var: example -var2: example -``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc index 09d4db0..2c3b813 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc @@ -3,89 +3,65 @@ [,yaml] ---- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 hidden: - type: jinja jinja: | {% if suffix == 'val2' %} disabled {% endif %} params: suffix: - type: suffix + type: identifier description: if suffix == 'val2' - var: # a variable + var: + description: a variable + mandatory: false family: # a family - var: # a new variable + var: + description: a new variable + mandatory: false ---- == Variables === a dynamic family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if suffix == 'val2'. +**Caché**: if suffix == 'val2'. This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 * val2 -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.var** ou **dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. |==== ==== a family -`basic` +`standard` -[cols="105a,105a",options="header"] +[cols="96a,96a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.family.var** ou **dynval2.family.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A new variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A new variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - var: example - family: - var: example -dynval2: - var: example - family: - var: example ----- -== Example with all variables modifiable - -[,yaml] ----- -dynval1: - var: example - family: - var: example -dynval2: - var: example - family: - var: example ----- diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md index e60fd02..47842d1 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md @@ -7,76 +7,52 @@ include_toc: true ```yaml --- version: '1.1' -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - val1 - val2 hidden: - type: jinja jinja: | {% if suffix == 'val2' %} disabled {% endif %} params: suffix: - type: suffix + type: identifier description: if suffix == 'val2' - var: # a variable + var: + description: a variable + mandatory: false family: # a family - var: # a new variable + var: + description: a new variable + mandatory: false ``` # Variables ## a dynamic family -`basic` _`hidden`_ +`standard` _`caché`_ -**Hidden**: if suffix == 'val2'. +**Caché**: if suffix == 'val2'. This family builds families dynamically. -**Suffixes**:
- val1
- val2 +**Identifiers**:
- val1
- val2 -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.var** ou **dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | ### a family -`basic` +`standard` -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A new variable. | +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.family.var** ou **dynval2.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - var: example - family: - var: example -dynval2: - var: example - family: - var: example -``` -# Example with all variables modifiable - -```yaml ---- -dynval1: - var: example - family: - var: example -dynval2: - var: example - family: - var: example -``` diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc index 31cc2ea..8ae0784 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc @@ -6,35 +6,32 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn_{{ suffix }}: +dyn_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside dynamic family default: - type: suffix + type: identifier var2: description: a variable default: - type: variable variable: _.dyn_val1.var ---- == Variables -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 -* val2 +* val2 |==== === a dynamic family @@ -44,39 +41,26 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **dyn_val1.var** ou **dyn_val2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable inside dynamic family. + -**Default**: value of the suffix. +**Défaut**: la valeur de identifier. |==== -[cols="108a,108a",options="header"] +[cols="110a,110a",options="header"] |==== -| Variable | Description +| Variable | Description | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A variable. + -**Default**: the value of the variable "dyn_val1.var". +**Défaut**: la valeur de la variable "dyn_val1.var". |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dyn_val1: - var: val1 -dyn_val2: - var: val2 -var2: val1 ----- diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md index 7ab812e..e9c7bca 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.md @@ -10,27 +10,24 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn_{{ suffix }}: +dyn_{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var var: description: a variable inside dynamic family default: - type: suffix + type: identifier var2: description: a variable default: - type: variable variable: _.dyn_val1.var ``` # Variables -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -39,27 +36,14 @@ var2: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dyn_val1.var** ou **dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: value of the suffix. | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_val1.var** ou **dyn_val2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable inside dynamic family.
**Défaut**: la valeur de identifier. | -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: the value of the variable "dyn_val1.var". | +| Variable                                                                                                     | Description                                                                                                  | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A variable.
**Défaut**: la valeur de la variable "dyn_val1.var". | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dyn_val1: - var: val1 -dyn_val2: - var: val2 -var2: val1 -``` diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc index 8eb3dd0..67b98a2 100644 --- a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc @@ -6,11 +6,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var leadership: description: a leadership @@ -32,9 +30,9 @@ dyn{{ suffix }}: | Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` `unique` `multiple` | A suffix variable. + -**Default**: +**Défaut**: * val1 * val2 @@ -47,7 +45,7 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". ==== a leadership @@ -61,7 +59,7 @@ This family contains lists of variable blocks. | Variable | Description | **dynval1.leadership.leader** ou **dynval2.leadership.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` `unique` `multiple` | A leader. | **dynval1.leadership.follower1** ou **dynval2.leadership.follower1** + @@ -74,21 +72,3 @@ A follower2. |==== -== Example with all variables modifiable - -[,yaml] ----- -var: - - val1 - - val2 -dynval1: - leadership: - - leader: example - follower1: example - follower2: example -dynval2: - leadership: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.md b/tests/docs/no_namespace/60_6family_dynamic_leadership.md index db85ea1..bf06795 100644 --- a/tests/docs/no_namespace/60_6family_dynamic_leadership.md +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.md @@ -10,11 +10,9 @@ version: '1.1' var: # a suffix variable - val1 - val2 -dyn{{ suffix }}: +dyn{{ identifier }}: description: a dynamic family - type: dynamic dynamic: - type: variable variable: _.var leadership: description: a leadership @@ -33,7 +31,7 @@ dyn{{ suffix }}: | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` `unique` `multiple` | A suffix variable.
**Défaut**:
- val1
- val2 | ## a dynamic family @@ -42,7 +40,7 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**: the value of the variable "var". +**Identifiers**: la valeur de la variable "var". ### a leadership @@ -53,26 +51,8 @@ This family contains lists of variable blocks. | Variable                                                                                       | Description                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.leadership.leader** ou **dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dynval1.leadership.leader** ou **dynval2.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` `unique` `multiple` | A leader. | | **dynval1.leadership.follower1** ou **dynval2.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | | **dynval1.leadership.follower2** ou **dynval2.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | -# Example with all variables modifiable - -```yaml ---- -var: - - val1 - - val2 -dynval1: - leadership: - - leader: example - follower1: example - follower2: example -dynval2: - leadership: - - leader: example - follower1: example - follower2: example -``` diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc index 0a1e3b5..938dd2b 100644 --- a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc @@ -4,25 +4,23 @@ ---- version: '1.1' var: val2 # a suffix variable -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: description: a dynamic family dynamic: - val1 - - type: variable - variable: _.var + - variable: _.var vardyn: # a dynamic variable ---- == Variables -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `obligatoire` | A suffix variable. + -**Default**: val2 +**Défaut**: val2 |==== === a dynamic family @@ -32,37 +30,18 @@ A suffix variable. + This family builds families dynamically. -**Suffixes**: +**Identifiers**: * val1 -* the value of the variable "var". +* la valeur de la variable "var". -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **dynval1.vardyn** ou **dynval2.vardyn** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A dynamic variable. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A dynamic variable. |==== -== Example with mandatory variables not filled in - -[,yaml] ----- -dynval1: - vardyn: example -dynval2: - vardyn: example ----- -== Example with all variables modifiable - -[,yaml] ----- -var: val2 -dynval1: - vardyn: example -dynval2: - vardyn: example ----- diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.md b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md index 6dc3929..2aed0e1 100644 --- a/tests/docs/no_namespace/60_9family_dynamic_calc_both.md +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.md @@ -8,20 +8,18 @@ include_toc: true --- version: '1.1' var: val2 # a suffix variable -dyn{{ suffix }}: - type: dynamic +dyn{{ identifier }}: description: a dynamic family dynamic: - val1 - - type: variable - variable: _.var + - variable: _.var vardyn: # a dynamic variable ``` # Variables -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `obligatoire` | A suffix variable.
**Défaut**: val2 | ## a dynamic family @@ -30,29 +28,10 @@ dyn{{ suffix }}: This family builds families dynamically. -**Suffixes**:
- val1
- the value of the variable "var". +**Identifiers**:
- val1
- la valeur de la variable "var". -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dynval1.vardyn** ou **dynval2.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A dynamic variable. | -# Example with mandatory variables not filled in - -```yaml ---- -dynval1: - vardyn: example -dynval2: - vardyn: example -``` -# Example with all variables modifiable - -```yaml ---- -var: val2 -dynval1: - vardyn: example -dynval2: - vardyn: example -``` diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.adoc b/tests/docs/no_namespace/68_0family_leadership_mode.adoc index 7065cab..2516c64 100644 --- a/tests/docs/no_namespace/68_0family_leadership_mode.adoc +++ b/tests/docs/no_namespace/68_0family_leadership_mode.adoc @@ -26,30 +26,21 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="107a,107a",options="header"] |==== -| Variable | Description +| Variable | Description | **leader.leader** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | -A leader. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `unique` `multiple` | +A leader. | **leader.follower1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A follower1. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. | **leader.follower2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -A follower2. +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `obligatoire` | +A follower2. |==== -== Example with all variables modifiable - -[,yaml] ----- -leader: - - leader: example - follower1: example - follower2: example ----- diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.md b/tests/docs/no_namespace/68_0family_leadership_mode.md index 57ff558..1a42a15 100644 --- a/tests/docs/no_namespace/68_0family_leadership_mode.md +++ b/tests/docs/no_namespace/68_0family_leadership_mode.md @@ -30,19 +30,10 @@ leader: This family contains lists of variable blocks. -| Variable                                                                                                | Description                                                                                             | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | -| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | -| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A follower2. | +| Variable                                                                                                  | Description                                                                                               | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `unique` `multiple` | A leader. | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `obligatoire` | A follower2. | -# Example with all variables modifiable - -```yaml ---- -leader: - - leader: example - follower1: example - follower2: example -```