diff --git a/src/rougail/output_doc/doc.py b/src/rougail/output_doc/doc.py index 8ec76c3..42dc41e 100644 --- a/src/rougail/output_doc/doc.py +++ b/src/rougail/output_doc/doc.py @@ -38,13 +38,13 @@ class RougailOutputDoc(Examples): def __init__( self, + config: "Config", *, - config: "Config" = None, rougailconfig: "RougailConfig" = None, **kwarg, ): # Import here to avoid circular import - from rougail import Rougail, CONVERT_OPTION + from rougail import CONVERT_OPTION self.convert_option = CONVERT_OPTION if rougailconfig is None: @@ -61,10 +61,6 @@ class RougailOutputDoc(Examples): raise Exception( f'cannot find output "{output}", available outputs: {list(outputs)}' ) - if config is None: - rougail = Rougail(rougailconfig) - rougail.converted.plugins.append("output_doc") - config = rougail.run() self.conf = config self.modes_level = rougailconfig["modes_level"] if self.modes_level: diff --git a/tests/docs/base/00_0version_underscore.sh b/tests/docs/base/00_0version_underscore.sh deleted file mode 100644 index 0c4d4fd..0000000 --- a/tests/docs/base/00_0version_underscore.sh +++ /dev/null @@ -1,18 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -_version: '1.1' -version: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.version - string basic mandatory A variable. - diff --git a/tests/docs/base/00_1empty_variable.sh b/tests/docs/base/00_1empty_variable.sh deleted file mode 100644 index edbc571..0000000 --- a/tests/docs/base/00_1empty_variable.sh +++ /dev/null @@ -1,18 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -empty: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.empty - string basic mandatory Empty. - diff --git a/tests/docs/base/00_2default_calculated.sh b/tests/docs/base/00_2default_calculated.sh deleted file mode 100644 index fc4ac1f..0000000 --- a/tests/docs/base/00_2default_calculated.sh +++ /dev/null @@ -1,32 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - multi: true - default: - jinja: | - {{ _.var1 }} - description: the value of var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: no - rougail.var2 - string standard mandatory unique multiple A second variable. - Default: the value of var1. - diff --git a/tests/docs/base/00_2default_calculated_multi.sh b/tests/docs/base/00_2default_calculated_multi.sh deleted file mode 100644 index 2cb6d75..0000000 --- a/tests/docs/base/00_2default_calculated_multi.sh +++ /dev/null @@ -1,39 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: # a first variable - - no - - yes - - maybe -var2: - description: a second variable - multi: true - default: - jinja: | - {% for val in _.var1 %} - {{ val }} - {% endfor %} - description: the value of _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A first variable. - Default: - - - • no - • yes - • maybe - | | rougail.var2 string standard mandatory unique multiple - | A second variable. Default: the value of _.var1. - | diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.sh b/tests/docs/base/00_2default_calculated_variable_transitive.sh deleted file mode 100644 index 1e61647..0000000 --- a/tests/docs/base/00_2default_calculated_variable_transitive.sh +++ /dev/null @@ -1,39 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 - -var1: - description: a first variable - multi: true - type: domainname - params: - allow_ip: true - -var2: - description: a second variable - default: - type: variable - variable: _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - -  Variable                                                   Description                                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - domainname basic mandatory unique multiple A first variable. - Validator: the domain name can be an IP - rougail.var2 - domainname standard mandatory unique multiple A second variable. - Validator: the domain name can be an IP - Default: the value of the variable "rougail.var1". - diff --git a/tests/docs/base/00_4load_subfolder.sh b/tests/docs/base/00_4load_subfolder.sh deleted file mode 100644 index e137f74..0000000 --- a/tests/docs/base/00_4load_subfolder.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/99-base.yml - -```yaml ---- -version: '1.0' -var1: - description: a variable -``` -# dictionaries/rougail2/00-base.yml - -```yaml ---- -version: '1.0' -var2: - description: a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory A variable. - rougail.var2 - string basic mandatory A variable. - diff --git a/tests/docs/base/00_5load_notype.sh b/tests/docs/base/00_5load_notype.sh deleted file mode 100644 index cb7527a..0000000 --- a/tests/docs/base/00_5load_notype.sh +++ /dev/null @@ -1,22 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -without_type: - description: a variable - default: non -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.without_type - string standard mandatory A variable. - Default: non - diff --git a/tests/docs/base/00_6boolean_no_mandatory.sh b/tests/docs/base/00_6boolean_no_mandatory.sh deleted file mode 100644 index 348407b..0000000 --- a/tests/docs/base/00_6boolean_no_mandatory.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - type: boolean - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                Description            - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - boolean standard A variable. - Default: true - diff --git a/tests/docs/base/00_6choice.sh b/tests/docs/base/00_6choice.sh deleted file mode 100644 index 140a31f..0000000 --- a/tests/docs/base/00_6choice.sh +++ /dev/null @@ -1,84 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: the first variable - choices: - - a - - b - - c -var2: - description: the second variable - choices: - - a - - b - - c -var3: - description: the third variable - choices: - - a - - b - - c - mandatory: false -var4: - description: the forth variable - choices: - - - - b - - c - mandatory: false -var5: - description: the fifth variable - choices: - - a - - b - - c - default: a -var6: - description: the sixth variable - choices: - - 1 - - 2 - - 3 - default: 1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - choice basic mandatory The first variable. - Choices: - - - • a - • b - • c | | rougail.var2 choice basic mandatory - | The second variable. Choices: - • a - • b - • c | | rougail.var3 choice standard - | The third variable. Choices: - • a - • b - • c - • null | | rougail.var4 choice standard - | The forth variable. Choices: - • null - • b - • c | | rougail.var5 choice standard mandatory - | The fifth variable. Choices: - • a ← (default) - • b - • c | | rougail.var6 choice standard mandatory - | The sixth variable. Choices: - • 1 ← (default) - • 2 - • 3 | diff --git a/tests/docs/base/00_6choice_calculation.sh b/tests/docs/base/00_6choice_calculation.sh deleted file mode 100644 index 1678175..0000000 --- a/tests/docs/base/00_6choice_calculation.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: - description: a variable - default: 9 - choices: - jinja: | - {% for n in trange(0, 10) %} - {{ n }} - {% endfor %} - return_type: number - description: choices is 0 to 9 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - choice standard mandatory A variable. - Choices: choices is 0 to 9. - Default: 9 - diff --git a/tests/docs/base/00_6choice_variable.sh b/tests/docs/base/00_6choice_variable.sh deleted file mode 100644 index ce3abb4..0000000 --- a/tests/docs/base/00_6choice_variable.sh +++ /dev/null @@ -1,35 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a second variable - - a - - b - - c -var2: - description: a first variable - default: a - choices: - variable: _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                                  Description                                              - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A second variable. - Default: - - - • a - • b - • c - | | rougail.var2 choice standard mandatory - | A first variable. Choices: the value of the variable "rougail.var1". Default: a - | diff --git a/tests/docs/base/00_6custom.sh b/tests/docs/base/00_6custom.sh deleted file mode 100644 index 1c5a8c6..0000000 --- a/tests/docs/base/00_6custom.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -custom1: - description: the first variable - type: custom -custom2: - description: the seconf variable - type: custom - default: value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.custom1 - custom basic mandatory The first variable. - rougail.custom2 - custom standard mandatory The seconf variable. - Default: value - diff --git a/tests/docs/base/00_6domainname.sh b/tests/docs/base/00_6domainname.sh deleted file mode 100644 index 6eec885..0000000 --- a/tests/docs/base/00_6domainname.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                               Description                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - domainname standard mandatory A domain name variable. - Default: my.domain.name - diff --git a/tests/docs/base/00_6domainname_params.sh b/tests/docs/base/00_6domainname_params.sh deleted file mode 100644 index 798d601..0000000 --- a/tests/docs/base/00_6domainname_params.sh +++ /dev/null @@ -1,27 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name - params: - allow_ip: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                       Description                                   - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - domainname standard mandatory A domain name variable. - Validator: the domain name can be an IP - Default: my.domain.name - diff --git a/tests/docs/base/00_6port.sh b/tests/docs/base/00_6port.sh deleted file mode 100644 index bc8d349..0000000 --- a/tests/docs/base/00_6port.sh +++ /dev/null @@ -1,38 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a port variable - type: port -variable2: - description: a port variable with default value - type: port - default: '8080' -variable3: - description: a port variable with integer default value - type: port - default: 8080 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - -  Variable                                       Description                                   - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable1 - port basic mandatory A port variable. - rougail.variable2 - port standard mandatory A port variable with default value. - Default: 8080 - rougail.variable3 - port standard mandatory A port variable with integer default value. - Default: 8080 - diff --git a/tests/docs/base/00_6regexp.sh b/tests/docs/base/00_6regexp.sh deleted file mode 100644 index 67d43c4..0000000 --- a/tests/docs/base/00_6regexp.sh +++ /dev/null @@ -1,34 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a first variable - regexp: ^#(?:[0-9a-f]{3}){1,2}$ - default: '#a1a1a1' - test: - - '#b1b1b1' - - '#b2b2b2' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                        Description                                                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - regexp standard mandatory A first variable. - Validator: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" - Default: #a1a1a1 - Examples: - - - • #b1b1b1 - • #b2b2b2 - | diff --git a/tests/docs/base/00_7choice_quote.sh b/tests/docs/base/00_7choice_quote.sh deleted file mode 100644 index 0b7a264..0000000 --- a/tests/docs/base/00_7choice_quote.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - type: choice - description: A choice - default: quote' - choices: - - quote' - - quote" - - quote"' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - choice standard mandatory A choice. - Choices: - - - • quote' ← (default) - • quote" - • quote"' | diff --git a/tests/docs/base/00_7help_quote.sh b/tests/docs/base/00_7help_quote.sh deleted file mode 100644 index df57f68..0000000 --- a/tests/docs/base/00_7help_quote.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var1: - description: the first variable - help: message with ' -var2: - description: the second variable - help: message with " -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory The first variable. - Message with '. - rougail.var2 - string basic mandatory The second variable. - Message with ". - diff --git a/tests/docs/base/00_7value_doublequote.sh b/tests/docs/base/00_7value_doublequote.sh deleted file mode 100644 index 43aae72..0000000 --- a/tests/docs/base/00_7value_doublequote.sh +++ /dev/null @@ -1,22 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: quote" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: quote" - diff --git a/tests/docs/base/00_7value_doublequote2.sh b/tests/docs/base/00_7value_doublequote2.sh deleted file mode 100644 index 10f4c49..0000000 --- a/tests/docs/base/00_7value_doublequote2.sh +++ /dev/null @@ -1,22 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: quote'" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: quote'" - diff --git a/tests/docs/base/00_7value_doublequote3.sh b/tests/docs/base/00_7value_doublequote3.sh deleted file mode 100644 index a2bb063..0000000 --- a/tests/docs/base/00_7value_doublequote3.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -variable: - description: a variable - default: quote\"\' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: quote"' - diff --git a/tests/docs/base/00_7value_quote.sh b/tests/docs/base/00_7value_quote.sh deleted file mode 100644 index b3e03a5..0000000 --- a/tests/docs/base/00_7value_quote.sh +++ /dev/null @@ -1,22 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -variable: - description: a variable - default: quote' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: quote' - diff --git a/tests/docs/base/00_8calculation_information.adoc b/tests/docs/base/00_8calculation_information.adoc deleted file mode 100644 index f73ed36..0000000 --- a/tests/docs/base/00_8calculation_information.adoc +++ /dev/null @@ -1,30 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: get information test_information. -|==== - diff --git a/tests/docs/base/00_8calculation_information.md b/tests/docs/base/00_8calculation_information.md deleted file mode 100644 index e9bbb52..0000000 --- a/tests/docs/base/00_8calculation_information.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information -``` -# Variables for "Rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/base/00_8calculation_information.sh b/tests/docs/base/00_8calculation_information.sh deleted file mode 100644 index 0b8158d..0000000 --- a/tests/docs/base/00_8calculation_information.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                          Description                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: get information test_information. - diff --git a/tests/docs/base/00_8test.sh b/tests/docs/base/00_8test.sh deleted file mode 100644 index d837ed8..0000000 --- a/tests/docs/base/00_8test.sh +++ /dev/null @@ -1,84 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var1: - description: the first variable - test: - - test - -var2: - description: the second variable - test: - - test - default: value - -var3: - description: the third variable - test: - - test1 - - test2 - -var4: - description: the forth variable - test: - - - - test1 - - test2 - mandatory: false - -var5: - description: the fifth variable - type: boolean - test: - - false - -var6: - description: the sixth variable - multi: true - test: - - test1 - - test2 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory The first variable. - Example: test - rougail.var2 - string standard mandatory The second variable. - Default: value - Example: test - rougail.var3 - string basic mandatory The third variable. - Examples: - - - • test1 - • test2 - | | rougail.var4 string standard - | The forth variable. Examples: - • null - • test1 - • test2 - | | rougail.var5 boolean standard mandatory - | The fifth variable. Default: true Example: false - | | rougail.var6 string basic mandatory unique multiple - | The sixth variable. Examples: - • test1 - • test2 - | diff --git a/tests/docs/base/00_9choice_variable_multi.sh b/tests/docs/base/00_9choice_variable_multi.sh deleted file mode 100644 index 508062e..0000000 --- a/tests/docs/base/00_9choice_variable_multi.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a first variable - type: choice - multi: true - choices: - - val1 - - val2 -variable2: - description: a second variable - type: choice - multi: true - mandatory: false - choices: - - val1 - - val2 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable1 - choice basic mandatory unique multiple A first variable. - Choices: - - - • val1 - • val2 - | | rougail.variable2 choice standard unique multiple - | A second variable. Choices: - • val1 - • val2 - | diff --git a/tests/docs/base/00_9choice_variables.sh b/tests/docs/base/00_9choice_variables.sh deleted file mode 100644 index f82f4f3..0000000 --- a/tests/docs/base/00_9choice_variables.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -source_variable_1: val1 # the first source variable -source_variable_2: val2 # the second source variable -my_variable: - description: a variable - type: choice - choices: - - variable: _.source_variable_1 - - variable: _.source_variable_2 - default: val1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                                    Description                                                - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.source_variable_1 - string standard mandatory The first source variable. - Default: val1 - rougail.source_variable_2 - string standard mandatory The second source variable. - Default: val2 - rougail.my_variable - choice standard mandatory A variable. - Choices: - - - • the value of the variable "rougail.source_variable_1". - • the value of the variable "rougail.source_variable_2". Default: val1 - | diff --git a/tests/docs/base/00_9default_calculation.adoc b/tests/docs/base/00_9default_calculation.adoc deleted file mode 100644 index 98a5588..0000000 --- a/tests/docs/base/00_9default_calculation.adoc +++ /dev/null @@ -1,32 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -variable: - description: a variable - default: - jinja: | - {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} - params: - param1: string - param2: 1 - param3: true - param4: - description: concat all parameters ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: concat all parameters. -|==== - diff --git a/tests/docs/base/00_9default_calculation.md b/tests/docs/base/00_9default_calculation.md deleted file mode 100644 index f831796..0000000 --- a/tests/docs/base/00_9default_calculation.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -variable: - description: a variable - default: - jinja: | - {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} - params: - param1: string - param2: 1 - param3: true - param4: - description: concat all parameters -``` -# Variables for "Rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | - diff --git a/tests/docs/base/00_9default_calculation.sh b/tests/docs/base/00_9default_calculation.sh deleted file mode 100644 index 734568c..0000000 --- a/tests/docs/base/00_9default_calculation.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -variable: - description: a variable - default: - jinja: | - {{ param1 }}_{{ param2 }}_{{ param3 }}_{{ param4 }} - params: - param1: string - param2: 1 - param3: true - param4: - description: concat all parameters -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                               Description                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: concat all parameters. - diff --git a/tests/docs/base/00_9default_calculation_information.adoc b/tests/docs/base/00_9default_calculation_information.adoc deleted file mode 100644 index 5124f7e..0000000 --- a/tests/docs/base/00_9default_calculation_information.adoc +++ /dev/null @@ -1,30 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: a variable - default: - jinja: '{{ information }}' - params: - information: - type: information - information: test_information - variable: _.var - description: returns the information ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: returns the information. -|==== - diff --git a/tests/docs/base/00_9default_calculation_information.sh b/tests/docs/base/00_9default_calculation_information.sh deleted file mode 100644 index d64abd4..0000000 --- a/tests/docs/base/00_9default_calculation_information.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a variable - default: - jinja: '{{ information }}' - params: - information: - type: information - information: test_information - variable: _.var - description: returns the information -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory A variable. - Default: returns the information. - diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.sh b/tests/docs/base/00_9default_calculation_information_other_variable.sh deleted file mode 100644 index da07c05..0000000 --- a/tests/docs/base/00_9default_calculation_information_other_variable.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - jinja: | - {{ information }} - params: - information: - type: information - information: test_information - variable: _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                  Description                              - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory A first variable. - rougail.var2 - string standard mandatory A second variable. - Default: depends on a calculation. - diff --git a/tests/docs/base/00_9default_calculation_multi_optional.sh b/tests/docs/base/00_9default_calculation_multi_optional.sh deleted file mode 100644 index e21af1d..0000000 --- a/tests/docs/base/00_9default_calculation_multi_optional.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -my_variable: - default: val1 -my_calculated_variable: - multi: true - default: - - variable: _.my_variable - optional: true - - variable: _.my_variable_unexists - optional: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_variable - string standard mandatory My_variable. - Default: val1 - rougail.my_calculated_variable - string standard mandatory unique multiple My_calculated_variable. - Default: the value of the variable "rougail.my_variable". - diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.sh b/tests/docs/base/00_9default_calculation_multi_optional2.sh deleted file mode 100644 index 5a12610..0000000 --- a/tests/docs/base/00_9default_calculation_multi_optional2.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -my_variable: - default: val1 -my_calculated_variable: - multi: true - default: - - variable: _.my_variable_unexists - optional: true - - variable: _.my_variable - optional: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_variable - string standard mandatory My_variable. - Default: val1 - rougail.my_calculated_variable - string standard mandatory unique multiple My_calculated_variable. - Default: the value of the variable "rougail.my_variable". - diff --git a/tests/docs/base/00_9default_calculation_optional.sh b/tests/docs/base/00_9default_calculation_optional.sh deleted file mode 100644 index 6560e2a..0000000 --- a/tests/docs/base/00_9default_calculation_optional.sh +++ /dev/null @@ -1,22 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -my_calculated_variable: - multi: true - default: - variable: _.my_variable - optional: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_calculated_variable - string standard mandatory unique multiple My_calculated_variable. - diff --git a/tests/docs/base/00_9default_calculation_optional_exists.sh b/tests/docs/base/00_9default_calculation_optional_exists.sh deleted file mode 100644 index 64d620e..0000000 --- a/tests/docs/base/00_9default_calculation_optional_exists.sh +++ /dev/null @@ -1,35 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -my_variable: - multi: true - default: - - val1 - - val2 -my_calculated_variable: - multi: true - default: - variable: _.my_variable - optional: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_variable - string standard mandatory unique multiple My_variable. - Default: - - - • val1 - • val2 - | | rougail.my_calculated_variable string standard mandatory unique multiple - | My_calculated_variable. Default: the value of the variable "rougail.my_variable". - | diff --git a/tests/docs/base/00_9default_calculation_param_optional.adoc b/tests/docs/base/00_9default_calculation_param_optional.adoc deleted file mode 100644 index 950b9d4..0000000 --- a/tests/docs/base/00_9default_calculation_param_optional.adoc +++ /dev/null @@ -1,44 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: a first variable - default: - jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 - }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' - params: - var2: - variable: _.var2 - optional: true - var3: - variable: _.var3 - optional: true - var4: - variable: _.unknown_family.var - optional: true - description: returns a value - mandatory: false -var2: no # a second variable ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | -A first variable. + -**Default**: returns a value. -| - -**rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A second variable. + -**Default**: no -|==== - diff --git a/tests/docs/base/00_9default_calculation_param_optional.sh b/tests/docs/base/00_9default_calculation_param_optional.sh deleted file mode 100644 index ba70385..0000000 --- a/tests/docs/base/00_9default_calculation_param_optional.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - default: - jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 - }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' - params: - var2: - variable: _.var2 - optional: true - var3: - variable: _.var3 - optional: true - var4: - variable: _.unknown_family.var - optional: true - description: returns a value - mandatory: false -var2: no # a second variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard A first variable. - Default: returns a value. - rougail.var2 - string standard mandatory A second variable. - Default: no - diff --git a/tests/docs/base/00_9default_information_other_variable.sh b/tests/docs/base/00_9default_information_other_variable.sh deleted file mode 100644 index 7986379..0000000 --- a/tests/docs/base/00_9default_information_other_variable.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - type: information - information: test_information - variable: _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                                                                        Description                                                                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory A first variable. - rougail.var2 - string standard mandatory A second variable. - Default: the value of the information "test_information" of the variable "rougail.var1". - diff --git a/tests/docs/base/00_9default_integer.sh b/tests/docs/base/00_9default_integer.sh deleted file mode 100644 index b31a575..0000000 --- a/tests/docs/base/00_9default_integer.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a variable - default: 9 - choices: - jinja: | - {% for item in trange(0, 10) %} - {{ item }} - {%- endfor %} - return_type: number - description: choice for 0 to 9 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - choice standard mandatory A variable. - Choices: choice for 0 to 9. - Default: 9 - diff --git a/tests/docs/base/00_9extra.sh b/tests/docs/base/00_9extra.sh deleted file mode 100644 index d498997..0000000 --- a/tests/docs/base/00_9extra.sh +++ /dev/null @@ -1,45 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: rougail # a variable -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: return no -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: rougail - - -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "extra" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - extra.variable - string standard mandatory A variable. - Default: return no. - diff --git a/tests/docs/base/00_9extra_calculation.sh b/tests/docs/base/00_9extra_calculation.sh deleted file mode 100644 index 8c048cd..0000000 --- a/tests/docs/base/00_9extra_calculation.sh +++ /dev/null @@ -1,69 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: value # a variable -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a first variable - default: - variable: rougail.variable -variable2: - description: a second variable - default: - jinja: | - {{ rougail.variable }} - description: copy the value of rougail.variable -variable3: - description: a third variable - default: - jinja: | - {{ variable }} - params: - variable: - variable: rougail.variable - description: copy the value of rougail.variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: value - - -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "extra" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                                      Description                                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - extra.variable1 - string standard mandatory A first variable. - Default: the value of the variable "rougail.variable". - extra.variable2 - string standard mandatory A second variable. - Default: copy the value of rougail.variable. - extra.variable3 - string standard mandatory A third variable. - Default: copy the value of rougail.variable. - diff --git a/tests/docs/base/01_6boolean_multi.sh b/tests/docs/base/01_6boolean_multi.sh deleted file mode 100644 index 1aa02b4..0000000 --- a/tests/docs/base/01_6boolean_multi.sh +++ /dev/null @@ -1,88 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - true -var2: - description: the second variable - default: - - true -var3: - description: the third variable - type: boolean - default: - - true -var4: # the forth variable - - false -var5: - description: the fifth variable - default: - - false -var6: - description: the sixth variable - type: boolean - default: - - false - -var7: - description: the seventh variable - multi: true - default: - - true -var8: - description: the eighth variable - type: boolean - multi: true - default: - - true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - - - - - - - - - -  Variable                                                Description                                            - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - boolean standard mandatory unique multiple The first variable. - Default: true - rougail.var2 - boolean standard mandatory unique multiple The second variable. - Default: true - rougail.var3 - boolean standard mandatory unique multiple The third variable. - Default: true - rougail.var4 - boolean standard mandatory unique multiple The forth variable. - Default: false - rougail.var5 - boolean standard mandatory unique multiple The fifth variable. - Default: false - rougail.var6 - boolean standard mandatory unique multiple The sixth variable. - Default: false - rougail.var7 - boolean standard mandatory unique multiple The seventh variable. - Default: true - rougail.var8 - boolean standard mandatory unique multiple The eighth variable. - Default: true - diff --git a/tests/docs/base/01_6custom_multi.sh b/tests/docs/base/01_6custom_multi.sh deleted file mode 100644 index 5d9a233..0000000 --- a/tests/docs/base/01_6custom_multi.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -custom1: - description: a first custom variable - type: custom - multi: true -custom2: - description: a second custom variable - type: custom - default: - - value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.custom1 - custom basic mandatory unique multiple A first custom variable. - rougail.custom2 - custom standard mandatory unique multiple A second custom variable. - Default: value - diff --git a/tests/docs/base/01_6float_multi.sh b/tests/docs/base/01_6float_multi.sh deleted file mode 100644 index 5d714ba..0000000 --- a/tests/docs/base/01_6float_multi.sh +++ /dev/null @@ -1,88 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - 0.0 -var2: - description: the second variable - default: - - 0.0 -var3: - description: the third variable - type: float - default: - - 0.0 -var4: # the forth variable - - 10.1 -var5: - description: the fifth variable - default: - - 10.1 -var6: - description: the sixth variable - type: float - default: - - 10.1 - -var7: - description: the seventh variable - multi: true - default: - - 0.0 -var8: - description: the eighth variable - type: float - multi: true - default: - - 0.0 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - - - - - - - - - -  Variable                                              Description                                          - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - float standard mandatory unique multiple The first variable. - Default: 0.0 - rougail.var2 - float standard mandatory unique multiple The second variable. - Default: 0.0 - rougail.var3 - float standard mandatory unique multiple The third variable. - Default: 0.0 - rougail.var4 - float standard mandatory unique multiple The forth variable. - Default: 10.1 - rougail.var5 - float standard mandatory unique multiple The fifth variable. - Default: 10.1 - rougail.var6 - float standard mandatory unique multiple The sixth variable. - Default: 10.1 - rougail.var7 - float standard mandatory unique multiple The seventh variable. - Default: 0.0 - rougail.var8 - float standard mandatory unique multiple The eighth variable. - Default: 0.0 - diff --git a/tests/docs/base/01_6number_multi.sh b/tests/docs/base/01_6number_multi.sh deleted file mode 100644 index 94691b7..0000000 --- a/tests/docs/base/01_6number_multi.sh +++ /dev/null @@ -1,88 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - 0 -var2: - description: the second variable - default: - - 0 -var3: - description: the third variable - type: number - default: - - 0 -var4: # the forth variable - - 10 -var5: - description: the fifth variable - default: - - 10 -var6: - description: the sixth variable - type: number - default: - - 10 - -var7: - description: the seventh variable - multi: true - default: - - 0 -var8: - description: the eighth variable - type: number - multi: true - default: - - 0 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - number standard mandatory unique multiple The first variable. - Default: 0 - rougail.var2 - number standard mandatory unique multiple The second variable. - Default: 0 - rougail.var3 - number standard mandatory unique multiple The third variable. - Default: 0 - rougail.var4 - number standard mandatory unique multiple The forth variable. - Default: 10 - rougail.var5 - number standard mandatory unique multiple The fifth variable. - Default: 10 - rougail.var6 - number standard mandatory unique multiple The sixth variable. - Default: 10 - rougail.var7 - number standard mandatory unique multiple The seventh variable. - Default: 0 - rougail.var8 - number standard mandatory unique multiple The eighth variable. - Default: 0 - diff --git a/tests/docs/base/01_6string_empty.sh b/tests/docs/base/01_6string_empty.sh deleted file mode 100644 index 97cb4ca..0000000 --- a/tests/docs/base/01_6string_empty.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: the second variable - empty: false - default: - - value - - -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple The second variable. - Default: - - - • value - • null - | diff --git a/tests/docs/base/01_6string_multi.sh b/tests/docs/base/01_6string_multi.sh deleted file mode 100644 index ee20879..0000000 --- a/tests/docs/base/01_6string_multi.sh +++ /dev/null @@ -1,78 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: [] # the first variable -var2: - description: the second variable - default: [] -var3: - description: the third variable - type: string -var4: # the forth variable - - value -var5: - description: the fifth variable - default: - - value -var6: - description: the sixth variable - type: string - default: - - value - -var7: - description: the seventh variable - multi: true - default: - - value -var8: - description: the eighth variable - type: string - multi: true - default: - - value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string basic mandatory unique multiple The first variable. - rougail.var2 - string basic mandatory unique multiple The second variable. - rougail.var3 - string basic mandatory The third variable. - rougail.var4 - string standard mandatory unique multiple The forth variable. - Default: value - rougail.var5 - string standard mandatory unique multiple The fifth variable. - Default: value - rougail.var6 - string standard mandatory unique multiple The sixth variable. - Default: value - rougail.var7 - string standard mandatory unique multiple The seventh variable. - Default: value - rougail.var8 - string standard mandatory unique multiple The eighth variable. - Default: value - diff --git a/tests/docs/base/01_7value_multi_doublequote.sh b/tests/docs/base/01_7value_multi_doublequote.sh deleted file mode 100644 index bc50731..0000000 --- a/tests/docs/base/01_7value_multi_doublequote.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: quote" - diff --git a/tests/docs/base/01_7value_multi_doublequote2.sh b/tests/docs/base/01_7value_multi_doublequote2.sh deleted file mode 100644 index bf53930..0000000 --- a/tests/docs/base/01_7value_multi_doublequote2.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote'" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: quote'" - diff --git a/tests/docs/base/01_7value_multi_quote.sh b/tests/docs/base/01_7value_multi_quote.sh deleted file mode 100644 index 034072f..0000000 --- a/tests/docs/base/01_7value_multi_quote.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: quote' - diff --git a/tests/docs/base/01_8calculation_information_multi.adoc b/tests/docs/base/01_8calculation_information_multi.adoc deleted file mode 100644 index 62052de..0000000 --- a/tests/docs/base/01_8calculation_information_multi.adoc +++ /dev/null @@ -1,31 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - multi: true - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: get information test_information. -|==== - diff --git a/tests/docs/base/01_8calculation_information_multi.md b/tests/docs/base/01_8calculation_information_multi.md deleted file mode 100644 index cd3620c..0000000 --- a/tests/docs/base/01_8calculation_information_multi.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - multi: true - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information -``` -# Variables for "Rougail" - -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: get information test_information. | - diff --git a/tests/docs/base/01_8calculation_information_multi.sh b/tests/docs/base/01_8calculation_information_multi.sh deleted file mode 100644 index 2edf7f5..0000000 --- a/tests/docs/base/01_8calculation_information_multi.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - multi: true - default: - jinja: | - {{test_information }} - params: - test_information: - type: information - information: test_information - description: get information test_information -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: get information test_information. - diff --git a/tests/docs/base/01_9choice_variable_multi.sh b/tests/docs/base/01_9choice_variable_multi.sh deleted file mode 100644 index 81bf5ed..0000000 --- a/tests/docs/base/01_9choice_variable_multi.sh +++ /dev/null @@ -1,34 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: # a first variable - - a - - b - - c -variable2: - description: a second variable - choices: - variable: _.variable1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                                       Description                                                   - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable1 - string standard mandatory unique multiple A first variable. - Default: - - - • a - • b - • c - | | rougail.variable2 choice basic mandatory - | A second variable. Choices: the value of the variable "rougail.variable1". - | diff --git a/tests/docs/base/04_0type_param.sh b/tests/docs/base/04_0type_param.sh deleted file mode 100644 index 672a689..0000000 --- a/tests/docs/base/04_0type_param.sh +++ /dev/null @@ -1,28 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -int: - description: A limited number - default: 10 - params: - min_number: 0 - max_number: 100 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.int - number standard mandatory A limited number. - Validators: - - - • the minimum value is 0 - • the maximum value is 100 Default: 10 | diff --git a/tests/docs/base/04_1auto_save.sh b/tests/docs/base/04_1auto_save.sh deleted file mode 100644 index ce2f3c2..0000000 --- a/tests/docs/base/04_1auto_save.sh +++ /dev/null @@ -1,23 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -variable: - description: an auto save variable - auto_save: true - default: no -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                        Description                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string basic mandatory auto modified An auto save variable. - Default: no - diff --git a/tests/docs/base/04_1auto_save_and_calculated.sh b/tests/docs/base/04_1auto_save_and_calculated.sh deleted file mode 100644 index 22720bf..0000000 --- a/tests/docs/base/04_1auto_save_and_calculated.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - auto_save: true - default: - variable: _.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                  Description                                              - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: no - rougail.var2 - string basic mandatory auto modified A second variable. - Default: the value of the variable "rougail.var1". - diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.sh b/tests/docs/base/04_1auto_save_and_calculated_hidden.sh deleted file mode 100644 index 43b4290..0000000 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.sh +++ /dev/null @@ -1,39 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - auto_save: true - hidden: - jinja: | - {% if _.var1 == "yes" %} - _.var1 is yes - {% endif %} - description: only if the variable var1 has value "yes" - default: - jinja: yes - description: the value is always yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - -  Variable                                                   Description                                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: no - rougail.var2 - string basic mandatory hidden auto modified A second variable. - Default: the value is always yes. - Hidden: only if the variable var1 has value "yes". - diff --git a/tests/docs/base/04_1auto_save_and_hidden.adoc b/tests/docs/base/04_1auto_save_and_hidden.adoc deleted file mode 100644 index 5fa72fd..0000000 --- a/tests/docs/base/04_1auto_save_and_hidden.adoc +++ /dev/null @@ -1,13 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: autosave variable - auto_save: true - hidden: true - default: yes - mandatory: false ----- diff --git a/tests/docs/base/04_1auto_save_and_hidden.md b/tests/docs/base/04_1auto_save_and_hidden.md deleted file mode 100644 index eb23d55..0000000 --- a/tests/docs/base/04_1auto_save_and_hidden.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: autosave variable - auto_save: true - hidden: true - default: yes - mandatory: false -``` diff --git a/tests/docs/base/04_1auto_save_and_hidden.sh b/tests/docs/base/04_1auto_save_and_hidden.sh deleted file mode 100644 index 4443d01..0000000 --- a/tests/docs/base/04_1auto_save_and_hidden.sh +++ /dev/null @@ -1,12 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: autosave variable - auto_save: true - hidden: true - default: yes - mandatory: false -``` diff --git a/tests/docs/base/04_1default_calculation_hidden.sh b/tests/docs/base/04_1default_calculation_hidden.sh deleted file mode 100644 index 2a5ff89..0000000 --- a/tests/docs/base/04_1default_calculation_hidden.sh +++ /dev/null @@ -1,47 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 - -var1: - description: a first variable - default: value - -var2: - description: a second variable - disabled: - variable: _.var1 - when: value - -var3: - description: a third variable - default: - jinja: | - {% if _.var1 == 'value' or _.var2 == 'blah' %} - value - {% endif %} -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                                                 Description                                                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: value - rougail.var2 - string basic mandatory disabled A second variable. - Disabled: when the variable "rougail.var1" has the value "value". - rougail.var3 - string standard mandatory A third variable. - Default: depends on a calculation. - diff --git a/tests/docs/base/04_1default_calculation_hidden_2.sh b/tests/docs/base/04_1default_calculation_hidden_2.sh deleted file mode 100644 index 0ec9521..0000000 --- a/tests/docs/base/04_1default_calculation_hidden_2.sh +++ /dev/null @@ -1,47 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 - -var1: - description: a first variable - default: value - -var2: - description: a second variable - disabled: - variable: _.var1 - when: value - -var3: - description: a third variable - default: - jinja: | - {% if _.var2 is propertyerror %} - value - {% endif %} -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                                                 Description                                                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: value - rougail.var2 - string basic mandatory disabled A second variable. - Disabled: when the variable "rougail.var1" has the value "value". - rougail.var3 - string standard mandatory A third variable. - Default: depends on a calculation. - diff --git a/tests/docs/base/04_5disabled_calculation.sh b/tests/docs/base/04_5disabled_calculation.sh deleted file mode 100644 index 5ff5bc1..0000000 --- a/tests/docs/base/04_5disabled_calculation.sh +++ /dev/null @@ -1,46 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a conditional variable -variable1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" -variable2: - description: a second variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                        Description                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A conditional variable. - Default: no - rougail.variable1 - string basic mandatory disabled A first variable. - Disabled: if condition is egal to "yes". - rougail.variable2 - string basic mandatory disabled A second variable. - Disabled: if condition is egal to "yes". - diff --git a/tests/docs/base/04_5disabled_calculation_default.sh b/tests/docs/base/04_5disabled_calculation_default.sh deleted file mode 100644 index 7823183..0000000 --- a/tests/docs/base/04_5disabled_calculation_default.sh +++ /dev/null @@ -1,61 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -condition: no # a condition - -var1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition - -var2: - description: a second variable - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - -  Variable                                        Description                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.var1 - string standard mandatory disabled A first variable. - Default: the value of condition. - Disabled: if condition is yes. - rougail.var2 - string standard mandatory disabled A second variable. - Default: the value of condition. - Disabled: if condition is yes. - diff --git a/tests/docs/base/04_5disabled_calculation_optional.adoc b/tests/docs/base/04_5disabled_calculation_optional.adoc deleted file mode 100644 index 3548078..0000000 --- a/tests/docs/base/04_5disabled_calculation_optional.adoc +++ /dev/null @@ -1,63 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if unknown is not defined %} - unknown is undefined - {% elif unknown == "no" %} - unknown is no - {% endif %} - params: - unknown: - variable: _.unknown - optional: true - description: calculation from an unknown variable - mandatory: false -var2: - description: a second variable - hidden: - jinja: | - {% if condition is not defined %} - condition is undefined - {% elif condition == "no" %} - condition is no - {% endif %} - params: - condition: - variable: _.condition - optional: true - description: calculation from an condition variable - mandatory: false ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.condition** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A condition. + -**Default**: no -| - -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | -A first variable. + -**Hidden**: calculation from an unknown variable. -| - -**rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | -A second variable. + -**Hidden**: calculation from an condition variable. -|==== - diff --git a/tests/docs/base/04_5disabled_calculation_optional.sh b/tests/docs/base/04_5disabled_calculation_optional.sh deleted file mode 100644 index 028ffbb..0000000 --- a/tests/docs/base/04_5disabled_calculation_optional.sh +++ /dev/null @@ -1,60 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if unknown is not defined %} - unknown is undefined - {% elif unknown == "no" %} - unknown is no - {% endif %} - params: - unknown: - variable: _.unknown - optional: true - description: calculation from an unknown variable - mandatory: false -var2: - description: a second variable - hidden: - jinja: | - {% if condition is not defined %} - condition is undefined - {% elif condition == "no" %} - condition is no - {% endif %} - params: - condition: - variable: _.condition - optional: true - description: calculation from an condition variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.var1 - string standard hidden A first variable. - Hidden: calculation from an unknown variable. - rougail.var2 - string standard hidden A second variable. - Hidden: calculation from an condition variable. - diff --git a/tests/docs/base/04_5disabled_calculation_variable.sh b/tests/docs/base/04_5disabled_calculation_variable.sh deleted file mode 100644 index d4c9ad0..0000000 --- a/tests/docs/base/04_5disabled_calculation_variable.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: false # a condition -variable: - description: a variable - disabled: - variable: _.condition -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                     Description                                                                 - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory A condition. - Default: false - rougail.variable - string basic mandatory disabled A variable. - Disabled: when the variable "rougail.condition" has the value "true". - diff --git a/tests/docs/base/04_5disabled_calculation_variable2.sh b/tests/docs/base/04_5disabled_calculation_variable2.sh deleted file mode 100644 index 24adaaa..0000000 --- a/tests/docs/base/04_5disabled_calculation_variable2.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -variable: - description: a variable - disabled: - variable: _.condition -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                     Description                                                                 - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory A condition. - Default: true - rougail.variable - string basic mandatory disabled A variable. - Disabled: when the variable "rougail.condition" has the value "true". - diff --git a/tests/docs/base/04_5disabled_calculation_variable3.sh b/tests/docs/base/04_5disabled_calculation_variable3.sh deleted file mode 100644 index 4bb1cb1..0000000 --- a/tests/docs/base/04_5disabled_calculation_variable3.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when: yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                    Description                                                                - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: yes - rougail.variable - string basic mandatory disabled A variable. - Disabled: when the variable "rougail.condition" has the value "yes". - diff --git a/tests/docs/base/04_5disabled_calculation_variable4.sh b/tests/docs/base/04_5disabled_calculation_variable4.sh deleted file mode 100644 index 8c69529..0000000 --- a/tests/docs/base/04_5disabled_calculation_variable4.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when_not: yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                       Description                                                                   - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: yes - rougail.variable - string basic mandatory disabled A variable. - Disabled: when the variable "rougail.condition" hasn't the value "yes". - diff --git a/tests/docs/base/04_5hidden_calculation.sh b/tests/docs/base/04_5hidden_calculation.sh deleted file mode 100644 index 64cb78b..0000000 --- a/tests/docs/base/04_5hidden_calculation.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the condition -var1: - description: a first variable - default: no - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -var2: - description: a second variable - default: no - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - -  Variable                                      Description                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory The condition. - Default: no - rougail.var1 - string standard mandatory hidden A first variable. - Default: no - Hidden: if condition is yes. - rougail.var2 - string standard mandatory hidden A second variable. - Default: no - Hidden: if condition is yes. - diff --git a/tests/docs/base/04_5hidden_calculation2.sh b/tests/docs/base/04_5hidden_calculation2.sh deleted file mode 100644 index d3e5145..0000000 --- a/tests/docs/base/04_5hidden_calculation2.sh +++ /dev/null @@ -1,58 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - -  Variable                                      Description                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.var1 - string standard mandatory hidden A first variable. - Default: the value of condition. - Hidden: if condition is yes. - rougail.var2 - string standard mandatory hidden A second variable. - Default: the value of condition. - Hidden: if condition is yes. - diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.sh b/tests/docs/base/04_5hidden_calculation_default_calculation.sh deleted file mode 100644 index 390a67a..0000000 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.sh +++ /dev/null @@ -1,58 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: returns the condition value -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: returns the condition value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - -  Variable                                      Description                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.var1 - string standard mandatory hidden A first variable. - Default: returns the condition value. - Hidden: if condition is yes. - rougail.var2 - string standard mandatory hidden A second variable. - Default: returns the condition value. - Hidden: if condition is yes. - diff --git a/tests/docs/base/04_5validators.sh b/tests/docs/base/04_5validators.sh deleted file mode 100644 index 664139b..0000000 --- a/tests/docs/base/04_5validators.sh +++ /dev/null @@ -1,28 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -int: - description: A number - type: number - validators: - - jinja: | - {% if _.int > 100 %} - value is too high - {% endif %} - description: the max value is 100 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                Description                            - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.int - number basic mandatory A number. - Validator: the max value is 100. - diff --git a/tests/docs/base/04_5validators_differ.sh b/tests/docs/base/04_5validators_differ.sh deleted file mode 100644 index ad9611d..0000000 --- a/tests/docs/base/04_5validators_differ.sh +++ /dev/null @@ -1,41 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - test: - - another_value - type: string - default: oui - validators: - - jinja: | - {% if _.var1 == _.var2 %} - var1 must be different than var2 - {% endif %} - description: var1 must be different than var2 -var2: no # A second variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Validator: var1 must be different than var2. - Default: oui - Example: another_value - rougail.var2 - string standard mandatory A second variable. - Default: no - diff --git a/tests/docs/base/04_5validators_multi.adoc b/tests/docs/base/04_5validators_multi.adoc deleted file mode 100644 index aea98f1..0000000 --- a/tests/docs/base/04_5validators_multi.adoc +++ /dev/null @@ -1,36 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var1: - description: a second variable - multi: true - default: - - no - - yes - validators: - - jinja: | - {% if _.var1 | length > 9 %} - length must be less than 10 - {% endif %} - description: check length is less than 10 ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A second variable. + -**Validator**: check length is less than 10. + -**Default**: - -* no -* yes -|==== - diff --git a/tests/docs/base/04_5validators_multi.sh b/tests/docs/base/04_5validators_multi.sh deleted file mode 100644 index 41122ba..0000000 --- a/tests/docs/base/04_5validators_multi.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: - description: a second variable - multi: true - default: - - no - - yes - validators: - - jinja: | - {% if _.var1 | length > 9 %} - length must be less than 10 - {% endif %} - description: check length is less than 10 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A second variable. - Validator: check length is less than 10. - Default: - - - • no - • yes - | diff --git a/tests/docs/base/04_5validators_multi2.adoc b/tests/docs/base/04_5validators_multi2.adoc deleted file mode 100644 index 0dc23fe..0000000 --- a/tests/docs/base/04_5validators_multi2.adoc +++ /dev/null @@ -1,48 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var1: - description: a second variable - multi: true - default: - - no - - yes - test: - - val1 - - val2 - validators: - - params: - values: - variable: _.var1 - whole: true - jinja: | - {% if values | length > 2 %} - length must be less than 3 - {% endif %} - description: check length is less than 3 ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A second variable. + -**Validator**: check length is less than 3. + -**Default**: - -* no -* yes - -**Examples**: - -* val1 -* val2 -|==== - diff --git a/tests/docs/base/04_5validators_multi2.sh b/tests/docs/base/04_5validators_multi2.sh deleted file mode 100644 index f2c7458..0000000 --- a/tests/docs/base/04_5validators_multi2.sh +++ /dev/null @@ -1,46 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: - description: a second variable - multi: true - default: - - no - - yes - test: - - val1 - - val2 - validators: - - params: - values: - variable: _.var1 - whole: true - jinja: | - {% if values | length > 2 %} - length must be less than 3 - {% endif %} - description: check length is less than 3 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A second variable. - Validator: check length is less than 3. - Default: - - - • no - • yes Examples: - • val1 - • val2 - | diff --git a/tests/docs/base/05_0multi_not_uniq.sh b/tests/docs/base/05_0multi_not_uniq.sh deleted file mode 100644 index 75d0753..0000000 --- a/tests/docs/base/05_0multi_not_uniq.sh +++ /dev/null @@ -1,24 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a variable - unique: false - default: - - non -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                      Description                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory multiple A variable. - Default: non - diff --git a/tests/docs/base/05_0multi_uniq.sh b/tests/docs/base/05_0multi_uniq.sh deleted file mode 100644 index 2c64918..0000000 --- a/tests/docs/base/05_0multi_uniq.sh +++ /dev/null @@ -1,24 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - unique: true - default: - - non -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: non - diff --git a/tests/docs/base/12_1auto_save_expert.sh b/tests/docs/base/12_1auto_save_expert.sh deleted file mode 100644 index ae30a61..0000000 --- a/tests/docs/base/12_1auto_save_expert.sh +++ /dev/null @@ -1,24 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: - description: a variable - auto_save: true - mode: advanced - default: no -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                           Description                                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string advanced mandatory auto modified A variable. - Default: no - diff --git a/tests/docs/base/16_0redefine_description.sh b/tests/docs/base/16_0redefine_description.sh deleted file mode 100644 index f113135..0000000 --- a/tests/docs/base/16_0redefine_description.sh +++ /dev/null @@ -1,28 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: Redefine description -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -var: - description: Redefined - redefine: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string basic mandatory Redefined. - diff --git a/tests/docs/base/16_2family_redefine_calculation.sh b/tests/docs/base/16_2family_redefine_calculation.sh deleted file mode 100644 index e06bb8b..0000000 --- a/tests/docs/base/16_2family_redefine_calculation.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -family: - redefine: true - disabled: - jinja: | - true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -family: - var1: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - rougail.family - -basic disabled - -Disabled: depends on a calculation. - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.var1 - string basic mandatory Var1. - diff --git a/tests/docs/base/16_2family_redefine_disabled.adoc b/tests/docs/base/16_2family_redefine_disabled.adoc deleted file mode 100644 index 4b2cf1e..0000000 --- a/tests/docs/base/16_2family_redefine_disabled.adoc +++ /dev/null @@ -1,19 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.0' -family: - redefine: true - disabled: true ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -family: - var1: ----- diff --git a/tests/docs/base/16_2family_redefine_disabled.md b/tests/docs/base/16_2family_redefine_disabled.md deleted file mode 100644 index 9ac5af4..0000000 --- a/tests/docs/base/16_2family_redefine_disabled.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -family: - redefine: true - disabled: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -family: - var1: -``` diff --git a/tests/docs/base/16_2family_redefine_disabled.sh b/tests/docs/base/16_2family_redefine_disabled.sh deleted file mode 100644 index 1bd1240..0000000 --- a/tests/docs/base/16_2family_redefine_disabled.sh +++ /dev/null @@ -1,17 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -family: - redefine: true - disabled: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -family: - var1: -``` diff --git a/tests/docs/base/16_5exists_nonexists.sh b/tests/docs/base/16_5exists_nonexists.sh deleted file mode 100644 index df8c889..0000000 --- a/tests/docs/base/16_5exists_nonexists.sh +++ /dev/null @@ -1,35 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var2: - description: a new variable - exists: false - default: yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A variable. - Default: no - rougail.var2 - string standard mandatory A new variable. - Default: yes - diff --git a/tests/docs/base/16_5exists_redefine.adoc b/tests/docs/base/16_5exists_redefine.adoc deleted file mode 100644 index 3a8a3a3..0000000 --- a/tests/docs/base/16_5exists_redefine.adoc +++ /dev/null @@ -1,28 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - redefine: true - exists: true - default: yes -var2: - description: a second variable - redefine: true - exists: true - default: yes ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: a first variable - hidden: true - default: no - mandatory: false ----- diff --git a/tests/docs/base/16_5exists_redefine.md b/tests/docs/base/16_5exists_redefine.md deleted file mode 100644 index 695da7d..0000000 --- a/tests/docs/base/16_5exists_redefine.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var1: - redefine: true - exists: true - default: yes -var2: - description: a second variable - redefine: true - exists: true - default: yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - hidden: true - default: no - mandatory: false -``` diff --git a/tests/docs/base/16_5exists_redefine.sh b/tests/docs/base/16_5exists_redefine.sh deleted file mode 100644 index cbebb4d..0000000 --- a/tests/docs/base/16_5exists_redefine.sh +++ /dev/null @@ -1,26 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var1: - redefine: true - exists: true - default: yes -var2: - description: a second variable - redefine: true - exists: true - default: yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - hidden: true - default: no - mandatory: false -``` diff --git a/tests/docs/base/16_5redefine_calculation.adoc b/tests/docs/base/16_5redefine_calculation.adoc deleted file mode 100644 index d913fe1..0000000 --- a/tests/docs/base/16_5redefine_calculation.adoc +++ /dev/null @@ -1,37 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - default: - jinja: yes - description: returns yes ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: returns no ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: returns yes. -|==== - diff --git a/tests/docs/base/16_5redefine_calculation.md b/tests/docs/base/16_5redefine_calculation.md deleted file mode 100644 index c6e8a3c..0000000 --- a/tests/docs/base/16_5redefine_calculation.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: - jinja: yes - description: returns yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: returns no -``` -# Variables for "Rougail" - -| Variable                                                                                                   | Description                                                                                                | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | - diff --git a/tests/docs/base/16_5redefine_calculation.sh b/tests/docs/base/16_5redefine_calculation.sh deleted file mode 100644 index 17b0b03..0000000 --- a/tests/docs/base/16_5redefine_calculation.sh +++ /dev/null @@ -1,35 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: - jinja: yes - description: returns yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: returns no -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory A variable. - Default: returns yes. - diff --git a/tests/docs/base/16_5redefine_choice.sh b/tests/docs/base/16_5redefine_choice.sh deleted file mode 100644 index b93b5cf..0000000 --- a/tests/docs/base/16_5redefine_choice.sh +++ /dev/null @@ -1,39 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - choices: - - a - - b - - c -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.0' -variable: - redefine: true - choices: - - a - - b -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - choice basic mandatory A variable. - Choices: - - - • a - • b | diff --git a/tests/docs/base/16_5redefine_default.adoc b/tests/docs/base/16_5redefine_default.adoc deleted file mode 100644 index 72433b7..0000000 --- a/tests/docs/base/16_5redefine_default.adoc +++ /dev/null @@ -1,33 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: no ----- -== dictionaries/rougail/01-redefine.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - default: yes ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | -A variable. + -**Default**: yes -|==== - diff --git a/tests/docs/base/16_5redefine_default_calculation.sh b/tests/docs/base/16_5redefine_default_calculation.sh deleted file mode 100644 index 95bbcee..0000000 --- a/tests/docs/base/16_5redefine_default_calculation.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string basic mandatory A variable. - diff --git a/tests/docs/base/16_5redefine_family.sh b/tests/docs/base/16_5redefine_family.sh deleted file mode 100644 index 7e4047a..0000000 --- a/tests/docs/base/16_5redefine_family.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - description: new description -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - variable: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - new description - -basic - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.variable - string basic mandatory A variable. - diff --git a/tests/docs/base/16_5redefine_help.adoc b/tests/docs/base/16_5redefine_help.adoc deleted file mode 100644 index 87b1f2a..0000000 --- a/tests/docs/base/16_5redefine_help.adoc +++ /dev/null @@ -1,45 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - redefine: true - help: redefine help family ok - variable: - redefine: true - help: redefine help ok ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - description: a family - help: redefine help family - variable: - description: redefine help - help: redefine help ----- -== Variables for "Rougail" - -=== a family - -`basic` - -Redefine help family ok. - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | -Redefine help. + -Redefine help ok. -|==== - diff --git a/tests/docs/base/16_5redefine_help.sh b/tests/docs/base/16_5redefine_help.sh deleted file mode 100644 index b0e5ea1..0000000 --- a/tests/docs/base/16_5redefine_help.sh +++ /dev/null @@ -1,44 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - help: redefine help family ok - variable: - redefine: true - help: redefine help ok -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: a family - help: redefine help family - variable: - description: redefine help - help: redefine help -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -basic - -Redefine help family ok. - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.variable - string basic mandatory Redefine help. - Redefine help ok. - diff --git a/tests/docs/base/16_5redefine_hidden.adoc b/tests/docs/base/16_5redefine_hidden.adoc deleted file mode 100644 index cb09425..0000000 --- a/tests/docs/base/16_5redefine_hidden.adoc +++ /dev/null @@ -1,19 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: no # a variable ----- -== dictionaries/rougail/01-redefine.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - hidden: true - mandatory: false ----- diff --git a/tests/docs/base/16_5redefine_hidden.md b/tests/docs/base/16_5redefine_hidden.md deleted file mode 100644 index 6233386..0000000 --- a/tests/docs/base/16_5redefine_hidden.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: no # a variable -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - hidden: true - mandatory: false -``` diff --git a/tests/docs/base/16_5redefine_hidden.sh b/tests/docs/base/16_5redefine_hidden.sh deleted file mode 100644 index 8ea19b8..0000000 --- a/tests/docs/base/16_5redefine_hidden.sh +++ /dev/null @@ -1,17 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: no # a variable -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - hidden: true - mandatory: false -``` diff --git a/tests/docs/base/16_5redefine_multi.adoc b/tests/docs/base/16_5redefine_multi.adoc deleted file mode 100644 index 025301b..0000000 --- a/tests/docs/base/16_5redefine_multi.adoc +++ /dev/null @@ -1,35 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: non ----- -== dictionaries/rougail/01-redefine.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - multi: true - default: - - non ----- -== Variables for "Rougail" - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | -A variable. + -**Default**: non -|==== - diff --git a/tests/docs/base/16_5redefine_multi.md b/tests/docs/base/16_5redefine_multi.md deleted file mode 100644 index 6970055..0000000 --- a/tests/docs/base/16_5redefine_multi.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: non -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - multi: true - default: - - non -``` -# Variables for "Rougail" - -| Variable                                                                                                                       | Description                                                                                                                    | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | - diff --git a/tests/docs/base/16_5redefine_multi.sh b/tests/docs/base/16_5redefine_multi.sh deleted file mode 100644 index 1cb1533..0000000 --- a/tests/docs/base/16_5redefine_multi.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: non -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - multi: true - default: - - non -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string standard mandatory unique multiple A variable. - Default: non - diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.sh b/tests/docs/base/16_5redefine_remove_disable_calculation.sh deleted file mode 100644 index 012411a..0000000 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.sh +++ /dev/null @@ -1,41 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - disabled: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -variable: - description: a variable - disabled: - jinja: | - {% if _.condition == "yes" %} - true - {% else %} - false - {% endif %} -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.variable - string basic mandatory A variable. - diff --git a/tests/docs/base/16_6choice_redefine.sh b/tests/docs/base/16_6choice_redefine.sh deleted file mode 100644 index bbdc6c1..0000000 --- a/tests/docs/base/16_6choice_redefine.sh +++ /dev/null @@ -1,41 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -var: - redefine: true - choices: - - a - - c -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - type: choice - description: A choice - default: c - choices: - - a - - b - - c -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - choice standard mandatory A choice. - Choices: - - - • a - • c ← (default) | diff --git a/tests/docs/base/16exists_exists.sh b/tests/docs/base/16exists_exists.sh deleted file mode 100644 index 833be92..0000000 --- a/tests/docs/base/16exists_exists.sh +++ /dev/null @@ -1,28 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var: - description: New description - exists: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: Description -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string basic mandatory Description. - diff --git a/tests/docs/base/17_5redefine_leadership.adoc b/tests/docs/base/17_5redefine_leadership.adoc deleted file mode 100644 index a02b2bb..0000000 --- a/tests/docs/base/17_5redefine_leadership.adoc +++ /dev/null @@ -1,26 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - redefine: true - hidden: true ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: # a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: false ----- diff --git a/tests/docs/base/17_5redefine_leadership.md b/tests/docs/base/17_5redefine_leadership.md deleted file mode 100644 index 58d32e4..0000000 --- a/tests/docs/base/17_5redefine_leadership.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - redefine: true - hidden: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: # a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/17_5redefine_leadership.sh b/tests/docs/base/17_5redefine_leadership.sh deleted file mode 100644 index ce9f7b3..0000000 --- a/tests/docs/base/17_5redefine_leadership.sh +++ /dev/null @@ -1,24 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - redefine: true - hidden: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: # a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/20_0empty_family.adoc b/tests/docs/base/20_0empty_family.adoc deleted file mode 100644 index 8ae6bd6..0000000 --- a/tests/docs/base/20_0empty_family.adoc +++ /dev/null @@ -1,9 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -my_family: - type: family ----- diff --git a/tests/docs/base/20_0empty_family.md b/tests/docs/base/20_0empty_family.md deleted file mode 100644 index d61994c..0000000 --- a/tests/docs/base/20_0empty_family.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -my_family: - type: family -``` diff --git a/tests/docs/base/20_0empty_family.sh b/tests/docs/base/20_0empty_family.sh deleted file mode 100644 index cc79b77..0000000 --- a/tests/docs/base/20_0empty_family.sh +++ /dev/null @@ -1,8 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -my_family: - type: family -``` diff --git a/tests/docs/base/20_0family_append.sh b/tests/docs/base/20_0family_append.sh deleted file mode 100644 index 5396702..0000000 --- a/tests/docs/base/20_0family_append.sh +++ /dev/null @@ -1,38 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - var2: - description: The second variable -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: A family - var1: - description: The first variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - A family - -basic - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.var1 - string basic mandatory The first variable. - rougail.family.var2 - string basic mandatory The second variable. - diff --git a/tests/docs/base/20_0family_underscore.adoc b/tests/docs/base/20_0family_underscore.adoc deleted file mode 100644 index 1233c95..0000000 --- a/tests/docs/base/20_0family_underscore.adoc +++ /dev/null @@ -1,43 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -my_family: - _type: family - _description: This is a great family - _help: This is a great family - _mode: standard - _hidden: true - _disabled: true - type: - description: a type family - type: family - my_variable: - mandatory: false - description: - description: This is a other great family - my_variable: - mandatory: false - help: - description: a help family - help: This is a other great family - my_variable: - mandatory: false - mode: - description: a mode family - mode: advanced - my_variable: - mandatory: false - hidden: - description: an hidden family - hidden: true - my_variable: - mandatory: false - disabled: - description: an disabled family - disabled: true - my_variable: - mandatory: false ----- diff --git a/tests/docs/base/20_0family_underscore.md b/tests/docs/base/20_0family_underscore.md deleted file mode 100644 index f75a46e..0000000 --- a/tests/docs/base/20_0family_underscore.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -my_family: - _type: family - _description: This is a great family - _help: This is a great family - _mode: standard - _hidden: true - _disabled: true - type: - description: a type family - type: family - my_variable: - mandatory: false - description: - description: This is a other great family - my_variable: - mandatory: false - help: - description: a help family - help: This is a other great family - my_variable: - mandatory: false - mode: - description: a mode family - mode: advanced - my_variable: - mandatory: false - hidden: - description: an hidden family - hidden: true - my_variable: - mandatory: false - disabled: - description: an disabled family - disabled: true - my_variable: - mandatory: false -``` diff --git a/tests/docs/base/20_0family_underscore.sh b/tests/docs/base/20_0family_underscore.sh deleted file mode 100644 index 932db63..0000000 --- a/tests/docs/base/20_0family_underscore.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -my_family: - _type: family - _description: This is a great family - _help: This is a great family - _mode: standard - _hidden: true - _disabled: true - type: - description: a type family - type: family - my_variable: - mandatory: false - description: - description: This is a other great family - my_variable: - mandatory: false - help: - description: a help family - help: This is a other great family - my_variable: - mandatory: false - mode: - description: a mode family - mode: advanced - my_variable: - mandatory: false - hidden: - description: an hidden family - hidden: true - my_variable: - mandatory: false - disabled: - description: an disabled family - disabled: true - my_variable: - mandatory: false -``` diff --git a/tests/docs/base/20_0multi_family.sh b/tests/docs/base/20_0multi_family.sh deleted file mode 100644 index 8b5cd5e..0000000 --- a/tests/docs/base/20_0multi_family.sh +++ /dev/null @@ -1,31 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: - description: a variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -standard - - a sub family - -standard - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.variable - string standard A variable. - diff --git a/tests/docs/base/20_0multi_family_basic.sh b/tests/docs/base/20_0multi_family_basic.sh deleted file mode 100644 index a0f2459..0000000 --- a/tests/docs/base/20_0multi_family_basic.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -basic - - a sub family - -basic - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.variable - string basic mandatory A variable. - diff --git a/tests/docs/base/20_0multi_family_expert.sh b/tests/docs/base/20_0multi_family_expert.sh deleted file mode 100644 index 1f5deee..0000000 --- a/tests/docs/base/20_0multi_family_expert.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: a family - mode: advanced - subfamily: # a sub family - variable: - description: a variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -advanced - - a sub family - -advanced - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.variable - string advanced A variable. - diff --git a/tests/docs/base/20_0multi_family_order.sh b/tests/docs/base/20_0multi_family_order.sh deleted file mode 100644 index a29f0cb..0000000 --- a/tests/docs/base/20_0multi_family_order.sh +++ /dev/null @@ -1,56 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: # a variable -family: # a family - variable1: # a first variable - subfamily: # a sub family - variable: # a variable - variable2: # a second variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.variable - string basic mandatory A variable. - - - - a family - -basic - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.variable1 - string basic mandatory A first variable. - - - a sub family - -basic - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.variable - string basic mandatory A variable. - - - - -  Variable                                 Description                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.variable2 - string basic mandatory A second variable. - diff --git a/tests/docs/base/20_0validators_differ_redefine.sh b/tests/docs/base/20_0validators_differ_redefine.sh deleted file mode 100644 index fc6e941..0000000 --- a/tests/docs/base/20_0validators_differ_redefine.sh +++ /dev/null @@ -1,60 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var3: - redefine: true - validators: - - jinja: | - {% if _.var3 == _.var2 %} - var3 must be different than var2 - {% endif %} - description: var3 must be different than var2 -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: no # a second variable -var3: - description: a third variable - default: yes - test: - - yes - validators: - - jinja: | - {% if _.var3 == _.var1 %} - var3 must be different than var1 - {% endif %} - description: var3 must be different than var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: no - rougail.var2 - string standard mandatory A second variable. - Default: no - rougail.var3 - string standard mandatory A third variable. - Validator: var3 must be different than var2. - Default: yes - Example: yes - diff --git a/tests/docs/base/20_1empty_subfamily.adoc b/tests/docs/base/20_1empty_subfamily.adoc deleted file mode 100644 index 2697f74..0000000 --- a/tests/docs/base/20_1empty_subfamily.adoc +++ /dev/null @@ -1,10 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -my_family: - my_sub_family: - type: family ----- diff --git a/tests/docs/base/20_1empty_subfamily.md b/tests/docs/base/20_1empty_subfamily.md deleted file mode 100644 index f876681..0000000 --- a/tests/docs/base/20_1empty_subfamily.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -my_family: - my_sub_family: - type: family -``` diff --git a/tests/docs/base/20_1empty_subfamily.sh b/tests/docs/base/20_1empty_subfamily.sh deleted file mode 100644 index 7a52420..0000000 --- a/tests/docs/base/20_1empty_subfamily.sh +++ /dev/null @@ -1,9 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -my_family: - my_sub_family: - type: family -``` diff --git a/tests/docs/base/20_9default_information_parent.sh b/tests/docs/base/20_9default_information_parent.sh deleted file mode 100644 index 5b61a39..0000000 --- a/tests/docs/base/20_9default_information_parent.sh +++ /dev/null @@ -1,35 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -family: - var1: # a first variable - var2: - description: a second variable - default: - type: information - information: test_information - variable: __.family -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - rougail.family - -basic - - - - - -  Variable                                                                                          Description                                                                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.var1 - string basic mandatory A first variable. - rougail.family.var2 - string standard mandatory A second variable. - Default: the value of the information "test_information" of the variable "rougail.family". - diff --git a/tests/docs/base/24_0family_hidden_condition.sh b/tests/docs/base/24_0family_hidden_condition.sh deleted file mode 100644 index ee3feb3..0000000 --- a/tests/docs/base/24_0family_hidden_condition.sh +++ /dev/null @@ -1,44 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - var1: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory The variable use has condition. - Default: no - - - - possibly hidden family - -basic hidden - -Hidden: if condition is yes. - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.var1 - string basic mandatory A variable. - diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.sh b/tests/docs/base/24_0family_hidden_condition_boolean.sh deleted file mode 100644 index 380f55c..0000000 --- a/tests/docs/base/24_0family_hidden_condition_boolean.sh +++ /dev/null @@ -1,46 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: false # a conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition %} - condition is false - {% endif %} - description: if not condition - variable: - description: a variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                            Description                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory A conditional variable. - Default: false - - - - a family - -standard hidden - -Hidden: if not condition. - - - -  Variable                            Description                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.variable - string standard A variable. - diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.sh b/tests/docs/base/24_0family_hidden_condition_sub_family.sh deleted file mode 100644 index 99f3050..0000000 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.sh +++ /dev/null @@ -1,49 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - subfamily: - var1: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory The variable use has condition. - Default: no - - - - possibly hidden family - -basic hidden - -Hidden: if condition is yes. - - rougail.family.subfamily - -basic - - - -  Variable                             Description                         - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.var1 - string basic mandatory A variable. - diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh deleted file mode 100644 index 0611789..0000000 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.sh +++ /dev/null @@ -1,47 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # the variable use has condition -family: - description: possibly hidden family - hidden: - variable: _.condition - subfamily: # a subfamily - var1: - description: a variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                            Description                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory The variable use has condition. - Default: true - - - - possibly hidden family - -standard hidden - -Hidden: when the variable "rougail.condition" has the value "true". - - a subfamily - -standard - - - -  Variable                             Description                         - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.subfamily.var1 - string standard A variable. - diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh b/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh deleted file mode 100644 index 85dbe4c..0000000 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if condition == "yes" %} - condition is yes - {% endif %} - params: - condition: - variable: _.condition - description: if condition is yes - sub_family: # a subfamily - var1: # a variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory The variable use has condition. - Default: no - - - - possibly hidden family - -basic hidden - -Hidden: if condition is yes. - - a subfamily - -basic - - - -  Variable                              Description                          - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.sub_family.var1 - string basic mandatory A variable. - diff --git a/tests/docs/base/24_0family_mandatory_condition.sh b/tests/docs/base/24_0family_mandatory_condition.sh deleted file mode 100644 index c6a5c2d..0000000 --- a/tests/docs/base/24_0family_mandatory_condition.sh +++ /dev/null @@ -1,33 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var: - description: a variable - mandatory: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: only if rougail.condition has the value "yes" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - rougail.var - string standard mandatory A variable. - Mandatory: only if rougail.condition has the value "yes". - diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.sh b/tests/docs/base/24_0family_mandatory_condition_variable.sh deleted file mode 100644 index f65a7a3..0000000 --- a/tests/docs/base/24_0family_mandatory_condition_variable.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -var: - description: a variable - mandatory: - variable: _.condition -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                                      Description                                                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory A condition. - Default: true - rougail.var - string standard mandatory A variable. - Mandatory: when the variable "rougail.condition" has the value "true". - diff --git a/tests/docs/base/24_7validators_variable_optional.adoc b/tests/docs/base/24_7validators_variable_optional.adoc deleted file mode 100644 index f22b2cb..0000000 --- a/tests/docs/base/24_7validators_variable_optional.adoc +++ /dev/null @@ -1,61 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -general: # a family - int: - description: a first number - type: number - test: - - 5 - validators: - - jinja: | - {% if _.int == int2 %} - int and int2 must be different - {% endif %} - params: - int2: - variable: _.int2 - optional: true - description: int and int2 must be different - - jinja: | - {% if int3 is defined and _.int == int3 %} - int and int3 must be different - {% endif %} - params: - int3: - variable: _.int3 - optional: true - description: int and int3 must be different - int2: 1 # a second number ----- -== Variables for "Rougail" - -=== a family - -`basic` - -[cols="1a,1a"] -|==== -| Variable | Description -| - -**rougail.general.int** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | -A first number. + -**Validators**: - -* int and int2 must be different. -* int and int3 must be different. - -**Example**: 5 -| - -**rougail.general.int2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | -A second number. + -**Default**: 1 -|==== - diff --git a/tests/docs/base/24_7validators_variable_optional.sh b/tests/docs/base/24_7validators_variable_optional.sh deleted file mode 100644 index ba3ca27..0000000 --- a/tests/docs/base/24_7validators_variable_optional.sh +++ /dev/null @@ -1,55 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -general: # a family - int: - description: a first number - type: number - test: - - 5 - validators: - - jinja: | - {% if _.int == int2 %} - int and int2 must be different - {% endif %} - params: - int2: - variable: _.int2 - optional: true - description: int and int2 must be different - - jinja: | - {% if int3 is defined and _.int == int3 %} - int and int3 must be different - {% endif %} - params: - int3: - variable: _.int3 - optional: true - description: int and int3 must be different - int2: 1 # a second number -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -basic - - - - -  Variable                             Description                         - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.general.int - number basic mandatory A first number. - Validators: - - - • int and int2 must be different. - • int and int3 must be different. Example: 5 | | rougail.general.int2 number standard - mandatory | A second number. Default: 1 - | diff --git a/tests/docs/base/24_family_disabled_var_hidden.adoc b/tests/docs/base/24_family_disabled_var_hidden.adoc deleted file mode 100644 index 2b8fd13..0000000 --- a/tests/docs/base/24_family_disabled_var_hidden.adoc +++ /dev/null @@ -1,17 +0,0 @@ -== 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 deleted file mode 100644 index 05c7bbb..0000000 --- a/tests/docs/base/24_family_disabled_var_hidden.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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/24_family_disabled_var_hidden.sh b/tests/docs/base/24_family_disabled_var_hidden.sh deleted file mode 100644 index ea598d4..0000000 --- a/tests/docs/base/24_family_disabled_var_hidden.sh +++ /dev/null @@ -1,16 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 - -family: - disabled: true - - var1: true # A description - - var2: - description: A description - hidden: - variable: _.var1 -``` diff --git a/tests/docs/base/40_0leadership.sh b/tests/docs/base/40_0leadership.sh deleted file mode 100644 index f3b05e0..0000000 --- a/tests/docs/base/40_0leadership.sh +++ /dev/null @@ -1,36 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: # a follower - follower2: # an other follower -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic mandatory unique multiple A leader. - rougail.leader.follower1 - string basic mandatory A follower. - rougail.leader.follower2 - string basic mandatory An other follower. - diff --git a/tests/docs/base/40_0leadership_diff_name.sh b/tests/docs/base/40_0leadership_diff_name.sh deleted file mode 100644 index bd1830a..0000000 --- a/tests/docs/base/40_0leadership_diff_name.sh +++ /dev/null @@ -1,36 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leadership: - description: a leadership - type: leadership - leader: [] # a leader - follower1: # a follower - follower2: # an other follower -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leadership.leader - string basic mandatory unique multiple A leader. - rougail.leadership.follower1 - string basic mandatory A follower. - rougail.leadership.follower2 - string basic mandatory An other follower. - diff --git a/tests/docs/base/40_0leadership_empty.adoc b/tests/docs/base/40_0leadership_empty.adoc deleted file mode 100644 index 741f544..0000000 --- a/tests/docs/base/40_0leadership_empty.adoc +++ /dev/null @@ -1,9 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -empty_leader: - type: leadership ----- diff --git a/tests/docs/base/40_0leadership_empty.md b/tests/docs/base/40_0leadership_empty.md deleted file mode 100644 index b7d0b8f..0000000 --- a/tests/docs/base/40_0leadership_empty.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -empty_leader: - type: leadership -``` diff --git a/tests/docs/base/40_0leadership_empty.sh b/tests/docs/base/40_0leadership_empty.sh deleted file mode 100644 index 9ba2e94..0000000 --- a/tests/docs/base/40_0leadership_empty.sh +++ /dev/null @@ -1,8 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -empty_leader: - type: leadership -``` diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.sh b/tests/docs/base/40_0leadership_follower_default_calculation.sh deleted file mode 100644 index d196606..0000000 --- a/tests/docs/base/40_0leadership_follower_default_calculation.sh +++ /dev/null @@ -1,45 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: value # a follower - follower2: - description: a second follower - default: - jinja: | - {{ _.follower1 }} - description: returns follower1 value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic mandatory unique multiple A leader. - rougail.leader.follower1 - string standard mandatory A follower. - Default: value - rougail.leader.follower2 - string standard mandatory A second follower. - Default: returns follower1 value. - diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.sh b/tests/docs/base/40_0leadership_follower_default_submulti.sh deleted file mode 100644 index f5d872d..0000000 --- a/tests/docs/base/40_0leadership_follower_default_submulti.sh +++ /dev/null @@ -1,50 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - leader - follower1: # a follower1 - - value - follower2: # a follower2 - - value1 - - value2 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -standard - -This family contains lists of variable blocks. - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple A leader. - Default: leader - rougail.leader.follower1 - string standard mandatory multiple A follower1. - Default: value - rougail.leader.follower2 - string standard mandatory multiple A follower2. - Default: - - - • value1 - • value2 - | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh deleted file mode 100644 index d7924fc..0000000 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.sh +++ /dev/null @@ -1,48 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # the leader - - leader - follower1: # the follower1 - - value - follower2: - description: the follower2 - multi: true - default: - variable: _.follower1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -standard - -This family contains lists of variable blocks. - - - - - - - - -  Variable                                                              Description                                                          - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple The leader. - Default: leader - rougail.leader.follower1 - string standard mandatory multiple The follower1. - Default: value - rougail.leader.follower2 - string standard mandatory multiple The follower2. - Default: the value of the variable "rougail.leader.follower1". - diff --git a/tests/docs/base/40_0leadership_follower_default_value.sh b/tests/docs/base/40_0leadership_follower_default_value.sh deleted file mode 100644 index 1aca439..0000000 --- a/tests/docs/base/40_0leadership_follower_default_value.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower1: value # a follower with default value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -standard - -This family contains lists of variable blocks. - - - - - -  Variable                                   Description                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard unique multiple A leader. - rougail.leader.follower1 - string standard mandatory A follower with default value. - Default: value - diff --git a/tests/docs/base/40_0leadership_leader_not_multi.sh b/tests/docs/base/40_0leadership_leader_not_multi.sh deleted file mode 100644 index 02c2e92..0000000 --- a/tests/docs/base/40_0leadership_leader_not_multi.sh +++ /dev/null @@ -1,67 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -general: - mode_conteneur_actif: - type: string - description: No change - default: non -general1: - leader: - description: leader - type: leadership - leader: - type: string - description: leader - follower1: - type: string - description: follower1 - follower2: - type: string - description: follower2 -version: '1.0' -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - rougail.general - -standard - - - - -  Variable                                    Description                                - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.general.mode_conteneur_actif - string standard mandatory No change. - Default: non - - - - rougail.general1 - -basic - - rougail.general1.leader - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.general1.leader.leader - string basic mandatory unique multiple Leader. - rougail.general1.leader.follower1 - string basic mandatory Follower1. - rougail.general1.leader.follower2 - string basic mandatory Follower2. - diff --git a/tests/docs/base/40_1leadership_append_follower.sh b/tests/docs/base/40_1leadership_append_follower.sh deleted file mode 100644 index 0adfe93..0000000 --- a/tests/docs/base/40_1leadership_append_follower.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - follower3: - description: the follower3 -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: the leader - multi: true - follower1: - description: the follower1 - follower2: - description: the follower2 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic mandatory unique multiple The leader. - rougail.leader.follower1 - string basic mandatory The follower1. - rougail.leader.follower2 - string basic mandatory The follower2. - rougail.leader.follower3 - string basic mandatory The follower3. - diff --git a/tests/docs/base/40_2leadership_calculation_index.sh b/tests/docs/base/40_2leadership_calculation_index.sh deleted file mode 100644 index 2668010..0000000 --- a/tests/docs/base/40_2leadership_calculation_index.sh +++ /dev/null @@ -1,45 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - type: index -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -standard - -This family contains lists of variable blocks. - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple A leader. - Default: - - - • a - • b - • c - | | rougail.leader.follower1 number standard mandatory - | A follower. Default: the value of the index. - | diff --git a/tests/docs/base/40_2leadership_calculation_param_index.sh b/tests/docs/base/40_2leadership_calculation_param_index.sh deleted file mode 100644 index 09e3f7c..0000000 --- a/tests/docs/base/40_2leadership_calculation_param_index.sh +++ /dev/null @@ -1,49 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - jinja: '{{ index }}' - params: - index: - type: index - description: returns index -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - leadership - -standard - -This family contains lists of variable blocks. - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple A leader. - Default: - - - • a - • b - • c - | | rougail.leader.follower1 number standard mandatory - | A follower. Default: returns index. - | diff --git a/tests/docs/base/40_2leadership_leader_calculation.sh b/tests/docs/base/40_2leadership_leader_calculation.sh deleted file mode 100644 index b87afc6..0000000 --- a/tests/docs/base/40_2leadership_leader_calculation.sh +++ /dev/null @@ -1,49 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - default: - jinja: | - val1 - val2 - description: returns val1 and val2 - - follower1: # a first follower - - follower2: # a second follower -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple A leader. - Default: returns val1 and val2. - rougail.leader.follower1 - string basic mandatory A first follower. - rougail.leader.follower2 - string basic mandatory A second follower. - diff --git a/tests/docs/base/40_6leadership_follower_multi.sh b/tests/docs/base/40_6leadership_follower_multi.sh deleted file mode 100644 index 855d474..0000000 --- a/tests/docs/base/40_6leadership_follower_multi.sh +++ /dev/null @@ -1,46 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leadership: - description: A leadership - type: leadership - leader: - description: The leader - multi: true - follower1: - description: The first follower - multi: true - follower2: - description: The second follower - multi: true - default: - - value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - A leadership - -basic - -This family contains lists of variable blocks. - - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leadership.leader - string basic mandatory unique multiple The leader. - rougail.leadership.follower1 - string basic mandatory multiple The first follower. - rougail.leadership.follower2 - string standard mandatory multiple The second follower. - Default: value - diff --git a/tests/docs/base/40_8calculation_boolean.sh b/tests/docs/base/40_8calculation_boolean.sh deleted file mode 100644 index 7e690b3..0000000 --- a/tests/docs/base/40_8calculation_boolean.sh +++ /dev/null @@ -1,56 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -bool: false # a boolean variable -multi1: - description: a first multi variable - type: boolean - multi: true - default: - jinja: | - {% if _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation -multi2: - description: a second multi variable - type: boolean - multi: true - default: - jinja: | - {% if not _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                                Description                                            - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.bool - boolean standard mandatory A boolean variable. - Default: false - rougail.multi1 - boolean standard mandatory unique multiple A first multi variable. - Default: a calculation. - rougail.multi2 - boolean standard mandatory unique multiple A second multi variable. - Default: a calculation. - diff --git a/tests/docs/base/40_8calculation_boolean_return_none.sh b/tests/docs/base/40_8calculation_boolean_return_none.sh deleted file mode 100644 index 3f28568..0000000 --- a/tests/docs/base/40_8calculation_boolean_return_none.sh +++ /dev/null @@ -1,34 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: yes # a first variable -var2: - description: a second variable - type: boolean - default: - jinja: | - {% if rougail.var1 == 'no' %} - false - {% endif %} - description: return false if the value of var1 is "no" -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - -  Variable                                                   Description                                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory A first variable. - Default: yes - rougail.var2 - boolean standard mandatory A second variable. - Default: return false if the value of var1 is "no". - diff --git a/tests/docs/base/40_8calculation_integer.sh b/tests/docs/base/40_8calculation_integer.sh deleted file mode 100644 index 35ecf51..0000000 --- a/tests/docs/base/40_8calculation_integer.sh +++ /dev/null @@ -1,44 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -bool: false # a boolean variable -int1: - description: first integer variable - type: number - default: - jinja: | - {% if rougail.bool %}1{% else %}2{% endif %} - description: if bool returns 1 otherwise return 2 -int2: - description: second integer variable - type: number - default: - jinja: | - {% if not rougail.bool %}3{% else %}4{% endif %} - description: if bool returns 3 otherwise return 4 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - - -  Variable                                              Description                                          - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.bool - boolean standard mandatory A boolean variable. - Default: false - rougail.int1 - number standard mandatory First integer variable. - Default: if bool returns 1 otherwise return 2. - rougail.int2 - number standard mandatory Second integer variable. - Default: if bool returns 3 otherwise return 4. - diff --git a/tests/docs/base/40_8calculation_multi_variable.sh b/tests/docs/base/40_8calculation_multi_variable.sh deleted file mode 100644 index d342368..0000000 --- a/tests/docs/base/40_8calculation_multi_variable.sh +++ /dev/null @@ -1,34 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a first variable - default: - - variable: _.var2 - - variable: _.var3 -var2: no # a second variable -var3: yes # a third variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A first variable. - Default: - - - • the value of the variable "rougail.var2". - • the value of the variable "rougail.var3". - | | rougail.var2 string standard mandatory - | A second variable. Default: no - | | rougail.var3 string standard mandatory - | A third variable. Default: yes - | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.sh b/tests/docs/base/40_8calculation_multi_variable_parent.sh deleted file mode 100644 index 8a2d5db..0000000 --- a/tests/docs/base/40_8calculation_multi_variable_parent.sh +++ /dev/null @@ -1,40 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: no # a variable -fam1: # a family - var: - description: a calculated variable - default: - variable: __.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory A variable. - Default: no - - - - a family - -standard - - - - -  Variable                                                 Description                                             - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.fam1.var - string standard mandatory A calculated variable. - Default: the value of the variable "rougail.var". - diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.sh b/tests/docs/base/40_8calculation_multi_variable_parent2.sh deleted file mode 100644 index 7981f9e..0000000 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.sh +++ /dev/null @@ -1,46 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -fam1: # first family - var: no # a variable -fam2: # second family - var: - description: a varaible - default: - variable: __.fam1.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - first family - -standard - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.fam1.var - string standard mandatory A variable. - Default: no - - - - second family - -standard - - - - -  Variable                                                      Description                                                  - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.fam2.var - string standard mandatory A varaible. - Default: the value of the variable "rougail.fam1.var". - diff --git a/tests/docs/base/41_0choice_leader.sh b/tests/docs/base/41_0choice_leader.sh deleted file mode 100644 index 54f53bd..0000000 --- a/tests/docs/base/41_0choice_leader.sh +++ /dev/null @@ -1,47 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: The leadership - type: leadership - leader: - description: The leader - multi: true - mandatory: false - follower1: - type: choice - description: A follower - choices: - - a - - b - - c -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - The leadership - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                   Description                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard unique multiple The leader. - rougail.leader.follower1 - choice basic mandatory A follower. - Choices: - - - • a - • b - • c | diff --git a/tests/docs/base/44_0leadership_hidden.adoc b/tests/docs/base/44_0leadership_hidden.adoc deleted file mode 100644 index adf33c9..0000000 --- a/tests/docs/base/44_0leadership_hidden.adoc +++ /dev/null @@ -1,20 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -leader: - description: a leadership - hidden: true - type: leadership - - leader: - description: a leader - mandatory: false - - follower: - description: a follower - mandatory: false ----- diff --git a/tests/docs/base/44_0leadership_hidden.md b/tests/docs/base/44_0leadership_hidden.md deleted file mode 100644 index 626b112..0000000 --- a/tests/docs/base/44_0leadership_hidden.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - hidden: true - type: leadership - - leader: - description: a leader - mandatory: false - - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/44_0leadership_hidden.sh b/tests/docs/base/44_0leadership_hidden.sh deleted file mode 100644 index 8a12034..0000000 --- a/tests/docs/base/44_0leadership_hidden.sh +++ /dev/null @@ -1,19 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - hidden: true - type: leadership - - leader: - description: a leader - mandatory: false - - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/44_0leadership_leader_hidden.adoc b/tests/docs/base/44_0leadership_leader_hidden.adoc deleted file mode 100644 index fad00ea..0000000 --- a/tests/docs/base/44_0leadership_leader_hidden.adoc +++ /dev/null @@ -1,21 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - hidden: true - mandatory: false - - follower: - description: a follower - mandatory: false ----- diff --git a/tests/docs/base/44_0leadership_leader_hidden.md b/tests/docs/base/44_0leadership_leader_hidden.md deleted file mode 100644 index a7690be..0000000 --- a/tests/docs/base/44_0leadership_leader_hidden.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - hidden: true - mandatory: false - - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/44_0leadership_leader_hidden.sh b/tests/docs/base/44_0leadership_leader_hidden.sh deleted file mode 100644 index 003b3f1..0000000 --- a/tests/docs/base/44_0leadership_leader_hidden.sh +++ /dev/null @@ -1,20 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - hidden: true - mandatory: false - - follower: - description: a follower - mandatory: false -``` diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.adoc b/tests/docs/base/44_1leadership_append_hidden_follower.adoc deleted file mode 100644 index ce2f656..0000000 --- a/tests/docs/base/44_1leadership_append_hidden_follower.adoc +++ /dev/null @@ -1,32 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - follower3: - description: follower3 - mandatory: false ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: true - mandatory: false - follower1: - description: the follower1 - mandatory: false - follower2: - description: the follower2 - mandatory: false ----- diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.md b/tests/docs/base/44_1leadership_append_hidden_follower.md deleted file mode 100644 index 87edbdd..0000000 --- a/tests/docs/base/44_1leadership_append_hidden_follower.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - follower3: - description: follower3 - mandatory: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: true - mandatory: false - follower1: - description: the follower1 - mandatory: false - follower2: - description: the follower2 - mandatory: false -``` diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.sh b/tests/docs/base/44_1leadership_append_hidden_follower.sh deleted file mode 100644 index ba8548b..0000000 --- a/tests/docs/base/44_1leadership_append_hidden_follower.sh +++ /dev/null @@ -1,30 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - follower3: - description: follower3 - mandatory: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: true - mandatory: false - follower1: - description: the follower1 - mandatory: false - follower2: - description: the follower2 - mandatory: false -``` diff --git a/tests/docs/base/44_4disabled_calcultion_follower.sh b/tests/docs/base/44_4disabled_calcultion_follower.sh deleted file mode 100644 index 425c4f9..0000000 --- a/tests/docs/base/44_4disabled_calcultion_follower.sh +++ /dev/null @@ -1,57 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -leader: - description: a leadership - type: leadership - leader: - description: aleader - default: - - a - follower: - description: a follower - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                            Description                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - boolean standard mandatory A condition. - Default: true - - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple Aleader. - Default: a - rougail.leader.follower - string basic mandatory disabled A follower. - Disabled: if condition is yes. - diff --git a/tests/docs/base/44_4leadership_mandatory.sh b/tests/docs/base/44_4leadership_mandatory.sh deleted file mode 100644 index e3291bd..0000000 --- a/tests/docs/base/44_4leadership_mandatory.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: true - follower1: - description: a follower - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic mandatory unique multiple A leader. - rougail.leader.follower1 - string standard A follower. - diff --git a/tests/docs/base/44_4leadership_mandatory_follower.sh b/tests/docs/base/44_4leadership_mandatory_follower.sh deleted file mode 100644 index f22e59c..0000000 --- a/tests/docs/base/44_4leadership_mandatory_follower.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: true -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - -  Variable                                   Description                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard unique multiple A leader. - rougail.leader.follower - string basic mandatory A follower. - diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.sh b/tests/docs/base/44_5leadership_leader_hidden_calculation.sh deleted file mode 100644 index cb8f28f..0000000 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.sh +++ /dev/null @@ -1,54 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: - jinja: | - {% if __.condition == "no" %} - condition is no - {% endif %} - description: if condition is no - mandatory: false - follower: # a follower -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: no - - - - a leadership - -basic hidden - -Hidden: if condition is no. - -This family contains lists of variable blocks. - - - - -  Variable                                   Description                               - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard unique multiple A leader. - rougail.leader.follower - string basic mandatory A follower. - diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.sh b/tests/docs/base/44_6leadership_follower_disabled_calculation.sh deleted file mode 100644 index c55974c..0000000 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.sh +++ /dev/null @@ -1,54 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower: - description: a follower - disabled: - jinja: | - {% if __.condition == "yes" %} - disabled - {% endif %} - description: if condition is yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.condition - string standard mandatory A condition. - Default: yes - - - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic mandatory unique multiple A leader. - rougail.leader.follower - string basic mandatory disabled A follower. - Disabled: if condition is yes. - diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.sh b/tests/docs/base/44_9calculated_default_leadership_leader.sh deleted file mode 100644 index 085cdcb..0000000 --- a/tests/docs/base/44_9calculated_default_leadership_leader.sh +++ /dev/null @@ -1,48 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -leader: - description: leader - type: leadership - leader: # a leader - - a - - b - follower: - description: a follower - disabled: - jinja: | - {% if _.leader == "a" %} - the value of "leader" is "a" - {% endif %} - description: if the value of "leader" is "a" - default: - variable: _.leader -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - rougail.leader - -standard - -This family contains lists of variable blocks. - - - - -  Variable                                                           Description                                                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string standard mandatory unique multiple A leader. - Default: - - - • a - • b - | | rougail.leader.follower string standard mandatory disabled - | A follower. Default: the value of the variable "rougail.leader.leader". Disabled: if the value of "leader" is "a". - | diff --git a/tests/docs/base/60_0family_dynamic.sh b/tests/docs/base/60_0family_dynamic.sh deleted file mode 100644 index ae94425..0000000 --- a/tests/docs/base/60_0family_dynamic.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: # A dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory A dynamic variable. - diff --git a/tests/docs/base/60_0family_dynamic_1_0.sh b/tests/docs/base/60_0family_dynamic_1_0.sh deleted file mode 100644 index ad72e0e..0000000 --- a/tests/docs/base/60_0family_dynamic_1_0.sh +++ /dev/null @@ -1,54 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - type: dynamic - variable: rougail.var - vardyn: - description: Dynamic variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - rougail.dynval1 or rougail.dynval2 - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.vardyn - rougail.dynval2.vardyn - string standard Dynamic variable. - diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.sh b/tests/docs/base/60_0family_dynamic_1_0_type.sh deleted file mode 100644 index 0181742..0000000 --- a/tests/docs/base/60_0family_dynamic_1_0_type.sh +++ /dev/null @@ -1,53 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - _type: dynamic - variable: rougail.var - vardyn: - description: A dyn variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - rougail.dynval1 or rougail.dynval2 - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.vardyn - rougail.dynval2.vardyn - string basic mandatory A dyn variable. - diff --git a/tests/docs/base/60_0family_dynamic_1_1.sh b/tests/docs/base/60_0family_dynamic_1_1.sh deleted file mode 100644 index 7481d7b..0000000 --- a/tests/docs/base/60_0family_dynamic_1_1.sh +++ /dev/null @@ -1,51 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn: - type: dynamic - description: A dynamic family - variable: _.var - vardyn: - description: A dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.vardyn - rougail.dynval2.vardyn - string basic mandatory A dynamic variable. - diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.sh b/tests/docs/base/60_0family_dynamic_jinja_number.sh deleted file mode 100644 index ba2660b..0000000 --- a/tests/docs/base/60_0family_dynamic_jinja_number.sh +++ /dev/null @@ -1,68 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - 1 - - 2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family -var2: - description: a variable - default: - jinja: | - {{ rougail.dyn1.var }} - description: get the value of rougail.dyn1.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - number standard mandatory unique multiple A suffix variable. - Default: - - - • 1 - • 2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dyn1.var - rougail.dyn2.var - string standard mandatory A variable inside dynamic family. - Default: val - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A variable. - Default: get the value of rougail.dyn1.var. - diff --git a/tests/docs/base/60_0family_dynamic_no_description.sh b/tests/docs/base/60_0family_dynamic_no_description.sh deleted file mode 100644 index 7aceb8b..0000000 --- a/tests/docs/base/60_0family_dynamic_no_description.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory Var. - diff --git a/tests/docs/base/60_0family_dynamic_static.sh b/tests/docs/base/60_0family_dynamic_static.sh deleted file mode 100644 index 9ab2e9e..0000000 --- a/tests/docs/base/60_0family_dynamic_static.sh +++ /dev/null @@ -1,37 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - var: # a variable inside a dynamic family -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a dynamic family - -basic - -This family builds families dynamically. - -Identifiers: - - • val1 - • val2 - - - - -  Variable                               Description                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory A variable inside a dynamic family. - diff --git a/tests/docs/base/60_0family_dynamic_test.sh b/tests/docs/base/60_0family_dynamic_test.sh deleted file mode 100644 index f9e8f27..0000000 --- a/tests/docs/base/60_0family_dynamic_test.sh +++ /dev/null @@ -1,56 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: - description: A suffix variable - multi: true - test: - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - - var: # A dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string basic mandatory unique multiple A suffix variable. - Examples: - - - • val1 - • val2 - | - - - A dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory A dynamic variable. - diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.sh b/tests/docs/base/60_0family_dynamic_variable_empty.sh deleted file mode 100644 index fbcc369..0000000 --- a/tests/docs/base/60_0family_dynamic_variable_empty.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: [] # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string basic mandatory unique multiple A suffix variable. - - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - -  Variable                                            Description                                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynexample.var - string standard mandatory A variable inside dynamic family. - Default: val - diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.sh b/tests/docs/base/60_0family_dynamic_variable_suffix.sh deleted file mode 100644 index 46191ee..0000000 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.sh +++ /dev/null @@ -1,54 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: a value # A dynamic variable with suffix {{ identifier }} -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard mandatory A dynamic variable with suffix val1. - A dynamic variable with suffix val2. - Default: a value - diff --git a/tests/docs/base/60_0family_empty.adoc b/tests/docs/base/60_0family_empty.adoc deleted file mode 100644 index a86d76a..0000000 --- a/tests/docs/base/60_0family_empty.adoc +++ /dev/null @@ -1,9 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -general2: - type: family ----- diff --git a/tests/docs/base/60_0family_empty.md b/tests/docs/base/60_0family_empty.md deleted file mode 100644 index 252df76..0000000 --- a/tests/docs/base/60_0family_empty.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -general2: - type: family -``` diff --git a/tests/docs/base/60_0family_empty.sh b/tests/docs/base/60_0family_empty.sh deleted file mode 100644 index 9592dac..0000000 --- a/tests/docs/base/60_0family_empty.sh +++ /dev/null @@ -1,8 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -general2: - type: family -``` diff --git a/tests/docs/base/60_0family_hidden.adoc b/tests/docs/base/60_0family_hidden.adoc deleted file mode 100644 index 60567a5..0000000 --- a/tests/docs/base/60_0family_hidden.adoc +++ /dev/null @@ -1,21 +0,0 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - redefine: true - hidden: true ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: # a family - var: - description: a variable - mandatory: false ----- diff --git a/tests/docs/base/60_0family_hidden.md b/tests/docs/base/60_0family_hidden.md deleted file mode 100644 index ee44f10..0000000 --- a/tests/docs/base/60_0family_hidden.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - hidden: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - var: - description: a variable - mandatory: false -``` diff --git a/tests/docs/base/60_0family_hidden.sh b/tests/docs/base/60_0family_hidden.sh deleted file mode 100644 index c589227..0000000 --- a/tests/docs/base/60_0family_hidden.sh +++ /dev/null @@ -1,19 +0,0 @@ -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - hidden: true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - var: - description: a variable - mandatory: false -``` diff --git a/tests/docs/base/60_0family_mode.sh b/tests/docs/base/60_0family_mode.sh deleted file mode 100644 index 51dbd5f..0000000 --- a/tests/docs/base/60_0family_mode.sh +++ /dev/null @@ -1,29 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - var: - description: A variable - mode: basic - default: non -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a family - -basic - - - - -  Variable                        Description                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.family.var - string basic mandatory A variable. - Default: non - diff --git a/tests/docs/base/60_1family_dynamic_jinja.sh b/tests/docs/base/60_1family_dynamic_jinja.sh deleted file mode 100644 index ab8638d..0000000 --- a/tests/docs/base/60_1family_dynamic_jinja.sh +++ /dev/null @@ -1,56 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - jinja: | - {% for val in _.var %} - {{ loop.index }} - {% endfor %} - description: index of suffix value - var: val # a dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -standard - -This family builds families dynamically. - -Identifiers: index of suffix value. - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dyn1.var - rougail.dyn2.var - string standard mandatory A dynamic variable. - Default: val - diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh deleted file mode 100644 index 44ba8c9..0000000 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.sh +++ /dev/null @@ -1,71 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - family: # a family - var: # with a variable -var2: - description: a second variable - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var1". - - a family - -basic - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.family.var - rougail.dynval2.family.var - string basic mandatory With a variable. - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A second variable. - Default: the value of var. - diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh deleted file mode 100644 index 3c1741f..0000000 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.sh +++ /dev/null @@ -1,77 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - family: - description: a family inside dynamic family - var: - description: a dynamic variable - default: - type: identifier -var2: - description: a varible outside dynamic family - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A identifier variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - a family inside dynamic family - -standard - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.family.var - rougail.dynval2.family.var - string standard mandatory A dynamic variable. - Default: the value of the identifier. - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A varible outside dynamic family. - Default: the value of var. - diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.sh b/tests/docs/base/60_2family_dynamic_outside_calc.sh deleted file mode 100644 index eb33278..0000000 --- a/tests/docs/base/60_2family_dynamic_outside_calc.sh +++ /dev/null @@ -1,68 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a suffx variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - var: val # a dynamic variable -newvar: - description: a second variable - default: - jinja: | - {{ _.dynval1.var }} - description: the value of var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A suffx variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var1". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard mandatory A dynamic variable. - Default: val - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.newvar - string standard mandatory A second variable. - Default: the value of var. - diff --git a/tests/docs/base/60_5family_dynamic_calc2.sh b/tests/docs/base/60_5family_dynamic_calc2.sh deleted file mode 100644 index 903f275..0000000 --- a/tests/docs/base/60_5family_dynamic_calc2.sh +++ /dev/null @@ -1,67 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -var2: # a second variable - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - hidden: - jinja: | - {% if _.var2 == "no" %} - var2 is no - {% endif %} - description: if var2 is no - - vardyn: val # a dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | | rougail.var2 string basic mandatory - | A second variable. - | - - - A dynamic family - -standard hidden - -Hidden: if var2 is no. - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.vardyn - rougail.dynval2.vardyn - string standard mandatory A dynamic variable. - Default: val - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.sh b/tests/docs/base/60_5family_dynamic_calc_suffix.sh deleted file mode 100644 index 6a645e4..0000000 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.sh +++ /dev/null @@ -1,70 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var1: - description: A suffix variable - default: - - val1 - - val2 - -dyn{{ identifier }}: - dynamic: - variable: _.var1 - - var: - description: A dynamic variable - -var2: - description: A variable calculated - default: - variable: rougail.dynval1.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - rougail.dynval1 or rougail.dynval2 - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var1". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory A dynamic variable. - - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A variable calculated. - Default: the value of the variable "rougail.dynval1.var". - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.sh b/tests/docs/base/60_5family_dynamic_calc_suffix2.sh deleted file mode 100644 index 386997f..0000000 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.sh +++ /dev/null @@ -1,55 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: Suffix has value - default: - type: identifier -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard mandatory Suffix has value. - Default: the value of the identifier. - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh deleted file mode 100644 index 151c77d..0000000 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.sh +++ /dev/null @@ -1,42 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -dyn{{ identifier }}: - dynamic: - - val1 - - val2 - var: - description: A dynamic variable - disabled: - type: identifier - when: val1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - rougail.dynval1 or rougail.dynval2 - -basic - -This family builds families dynamically. - -Identifiers: - - • val1 - • val2 - - - - - -  Variable                                        Description                                    - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory disabled A dynamic variable. - Disabled: when the identifier is "val1". - diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh b/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh deleted file mode 100644 index 6ad2b28..0000000 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.sh +++ /dev/null @@ -1,60 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - default: - jinja: | - {{ identifier }} - params: - identifier: - type: identifier - description: from suffix -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A identifier variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard mandatory A dynamic variable. - Default: from suffix. - diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.sh b/tests/docs/base/60_5family_dynamic_calc_variable.sh deleted file mode 100644 index ea25787..0000000 --- a/tests/docs/base/60_5family_dynamic_calc_variable.sh +++ /dev/null @@ -1,67 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: A suffix variable - default: - - val1 - - val2 -dyn{{ identifier }}: - dynamic: - variable: _.var1 - propertyerror: false - var: - description: A dynamic variable -var2: - description: A variable calculated - default: - variable: _.dynval1.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var1 - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - rougail.dynval1 or rougail.dynval2 - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var1". - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string basic mandatory A dynamic variable. - - - - - -  Variable                                                         Description                                                     - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A variable calculated. - Default: the value of the variable "rougail.dynval1.var". - diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.sh b/tests/docs/base/60_5family_dynamic_hidden_suffix.sh deleted file mode 100644 index b9cfffc..0000000 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.sh +++ /dev/null @@ -1,69 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - hidden: - jinja: | - {% if suffix == 'val2' %} - disabled - {% endif %} - params: - suffix: - type: identifier - description: if suffix == 'val2' - - var: - description: a variable - mandatory: false - family: # a family - var: - description: a new variable - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - a dynamic family - -standard hidden - -Hidden: if suffix == 'val2'. - -This family builds families dynamically. - -Identifiers: - - • val1 - • val2 - - - - -  Variable                     Description                 - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard A variable. - - - a family - -standard - - - - -  Variable                            Description                        - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.family.var - rougail.dynval2.family.var - string standard A new variable. - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.sh b/tests/docs/base/60_5family_dynamic_variable_outside.sh deleted file mode 100644 index 3ab1a46..0000000 --- a/tests/docs/base/60_5family_dynamic_variable_outside.sh +++ /dev/null @@ -1,75 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -var2: - description: a variable - multi: true - default: - variable: rougail.my_dyn_family_{{ identifier }}.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_dyn_family_val1.var - rougail.my_dyn_family_val2.var - string standard A variable inside a dynamic family. - Default: the value of the identifier. - - - - - -  Variable                                                          Description                                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory unique multiple A variable. - Default: - - - • the value of the variable "rougail.my_dyn_family_val1.var" - • the value of the variable "rougail.my_dyn_family_val2.var" - | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.sh b/tests/docs/base/60_5family_dynamic_variable_outside2.sh deleted file mode 100644 index d97f42f..0000000 --- a/tests/docs/base/60_5family_dynamic_variable_outside2.sh +++ /dev/null @@ -1,69 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var2: - description: a variable - multi: true - default: - variable: rougail.my_dyn_family_{{ identifier }}.var - -var: # a suffix variable - - val1 - - val2 - -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                                          Description                                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory unique multiple A variable. - Default: - - - • the value of the variable "rougail.my_dyn_family_val1.var" - • the value of the variable "rougail.my_dyn_family_val2.var" - | | rougail.var string standard mandatory unique multiple - | A suffix variable. Default: - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                                          Description                                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_dyn_family_val1.var - rougail.my_dyn_family_val2.var - string standard A variable inside a dynamic family. - Default: the value of the identifier. - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh deleted file mode 100644 index b18f467..0000000 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.sh +++ /dev/null @@ -1,77 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -var2: - description: a variable - multi: true - default: - jinja: |- - {%- for v in var %} - {{ v }} - {%- endfor -%} - params: - var: - variable: rougail.my_dyn_family_{{ identifier }}.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.my_dyn_family_val1.var - rougail.my_dyn_family_val2.var - string standard A variable inside a dynamic family. - Default: the value of the identifier. - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory unique multiple A variable. - Default: depends on a calculation. - diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh deleted file mode 100644 index 2bf8f87..0000000 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.sh +++ /dev/null @@ -1,69 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside dynamic family - default: - type: identifier -var2: - description: a variable - default: - variable: _.dyn_val1.var -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dyn_val1.var - rougail.dyn_val2.var - string standard mandatory A variable inside dynamic family. - Default: the value of the identifier. - - - - - -  Variable                                                          Description                                                      - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var2 - string standard mandatory A variable. - Default: the value of the variable "rougail.dyn_val1.var". - diff --git a/tests/docs/base/60_6family_dynamic_inside.sh b/tests/docs/base/60_6family_dynamic_inside.sh deleted file mode 100644 index 46986fa..0000000 --- a/tests/docs/base/60_6family_dynamic_inside.sh +++ /dev/null @@ -1,85 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 - -'{{ identifier }}_dyn': - description: a dynamic family - dynamic: - variable: _.var - var1: - description: value is suffix - default: - type: identifier - var2: - description: value is first variable - default: - variable: rougail.{{ identifier }}_dyn.var1 - var3: - description: value is relative first variable - default: - variable: _.var1 - var4: - description: value is first variable of val1 - default: - variable: rougail.val1_dyn.var1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - - - - -  Variable                                                           Description                                                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.val1_dyn.var1 - rougail.val2_dyn.var1 - string standard mandatory Value is suffix. - Default: the value of the identifier. - rougail.val1_dyn.var2 - rougail.val2_dyn.var2 - string standard mandatory Value is first variable. - Default: - - - • the value of the variable "rougail.val1_dyn.var1" - • the value of the variable "rougail.val2_dyn.var1" - | | rougail.val1_dyn.var3 rougail.val2_dyn.var3 string standard mandatory - | Value is relative first variable. Default: - • the value of the variable "rougail.val1_dyn.var1" - • the value of the variable "rougail.val2_dyn.var1" - | | rougail.val1_dyn.var4 rougail.val2_dyn.var4 string standard mandatory - | Value is first variable of val1. Default: the value of the variable "rougail.val1_dyn.var1". - | diff --git a/tests/docs/base/60_6family_dynamic_leadership.sh b/tests/docs/base/60_6family_dynamic_leadership.sh deleted file mode 100644 index 76dd22b..0000000 --- a/tests/docs/base/60_6family_dynamic_leadership.sh +++ /dev/null @@ -1,77 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - leadership: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A suffix variable. - Default: - - - • val1 - • val2 - | - - - a dynamic family - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - a leadership - -basic - -This family contains lists of variable blocks. - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.leadership.leader - rougail.dynval2.leadership.leader - string basic mandatory unique multiple A leader. - rougail.dynval1.leadership.follower1 - rougail.dynval2.leadership.follower1 - string standard A follower1. - rougail.dynval1.leadership.follower2 - rougail.dynval2.leadership.follower2 - string standard A follower2. - diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.sh b/tests/docs/base/60_6family_dynamic_sub_dynamic.sh deleted file mode 100644 index 6a8d828..0000000 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.sh +++ /dev/null @@ -1,135 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - multi: true - default: - jinja: | - {% for val in __.var %} - t{{ val }} - {% endfor %} - description: add 't' to each var value - dyn_{{ identifier }}: - description: a Second dynamic variable - dynamic: - variable: rougail.dyn{{ identifier }}.var - var: - description: A variable dynamic - default: - type: identifier - var_identifier: - description: identifier from first family - default: - type: identifier - identifier: 0 - var_identifiers: - description: merge identifiers - default: - jinja: | - {{ s1 }}-{{ s2 }} - params: - s1: - type: identifier - identifier: 0 - s2: - type: identifier - identifier: 1 - description: join identifier 1 et identifier 2 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A identifier variable. - Default: - - - • val1 - • val2 - | - - - A dynamic family - -standard - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.var - rougail.dynval2.var - string standard mandatory unique multiple A dynamic variable. - Default: add 't' to each var value. - - - a Second dynamic variable - -standard - -This family builds families dynamically. - -Identifiers: - - • the value of the variable "rougail.dynval1.var" - • the value of the variable "rougail.dynval2.var" - - - - - - - - - - - - - - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.dyn_tval1.var - rougail.dynval1.dyn_tval2.var - rougail.dynval2.dyn_tval1.var - rougail.dynval2.dyn_tval2.var - string standard mandatory A variable dynamic. - Default: the value of the identifier. - rougail.dynval1.dyn_tval1.var_identifier - rougail.dynval1.dyn_tval2.var_identifier - rougail.dynval2.dyn_tval1.var_identifier - rougail.dynval2.dyn_tval2.var_identifier - string standard mandatory Identifier from first family. - Default: the value of the identifier. - rougail.dynval1.dyn_tval1.var_identifiers - rougail.dynval1.dyn_tval2.var_identifiers - rougail.dynval2.dyn_tval1.var_identifiers - rougail.dynval2.dyn_tval2.var_identifiers - string standard mandatory Merge identifiers. - Default: join identifier 1 et identifier 2. - diff --git a/tests/docs/base/60_9extra_dynamic.sh b/tests/docs/base/60_9extra_dynamic.sh deleted file mode 100644 index 8d8d187..0000000 --- a/tests/docs/base/60_9extra_dynamic.sh +++ /dev/null @@ -1,52 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: # a variable - - a -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: 1.1 -dyn_{{ identifier }}: - dynamic: - variable: rougail.var - var: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory unique multiple A variable. - Default: a - - -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "extra" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - extra.dyn_a - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "rougail.var". - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - extra.dyn_a.var - string basic mandatory Var. - diff --git a/tests/docs/base/60_9extra_dynamic_extra.sh b/tests/docs/base/60_9extra_dynamic_extra.sh deleted file mode 100644 index 551d7a9..0000000 --- a/tests/docs/base/60_9extra_dynamic_extra.sh +++ /dev/null @@ -1,75 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -general: - description: général - varname: - type: string - description: No change - multi: true - default: - - a -version: '1.0' -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -var: # a varaible - - a -dyn_{{ identifier }}: - dynamic: - variable: _.var - var: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - général - -standard - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.general.varname - string standard mandatory unique multiple No change. - Default: a - - -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "extra" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - extra.var - string standard mandatory unique multiple A varaible. - Default: a - - - - extra.dyn_a - -basic - -This family builds families dynamically. - -Identifiers: the value of the variable "extra.var". - - - -  Variable                                               Description                                           - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - extra.dyn_a.var - string basic mandatory Var. - diff --git a/tests/docs/base/60_9family_dynamic_calc_both.sh b/tests/docs/base/60_9family_dynamic_calc_both.sh deleted file mode 100644 index 243d94d..0000000 --- a/tests/docs/base/60_9family_dynamic_calc_both.sh +++ /dev/null @@ -1,48 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: val2 # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - variable: _.var - vardyn: # a dynamic variable -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.var - string standard mandatory A suffix variable. - Default: val2 - - - - a dynamic family - -basic - -This family builds families dynamically. - -Identifiers: - - • val1 - • the value of the variable "rougail.var". - - - - -  Variable                           Description                       - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.dynval1.vardyn - rougail.dynval2.vardyn - string basic mandatory A dynamic variable. - diff --git a/tests/docs/base/68_0family_leadership_mode.sh b/tests/docs/base/68_0family_leadership_mode.sh deleted file mode 100644 index e55447f..0000000 --- a/tests/docs/base/68_0family_leadership_mode.sh +++ /dev/null @@ -1,43 +0,0 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: A leadership - type: leadership - leader: - description: A leader - multi: true - mandatory: false - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mode: basic -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - A leadership - -basic - -This family contains lists of variable blocks. - - - - - -  Variable                                Description                            - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - rougail.leader.leader - string basic unique multiple A leader. - rougail.leader.follower1 - string standard A follower1. - rougail.leader.follower2 - string basic mandatory A follower2. - diff --git a/tests/docs/examples/16_6exists_redefine_family.md b/tests/docs/examples/16_6exists_redefine_family.md new file mode 100644 index 0000000..c696c22 --- /dev/null +++ b/tests/docs/examples/16_6exists_redefine_family.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/01-base.yml + +```yaml +--- +version: '1.1' + +family1: + exists: true + redefine: true + description: new description + +family2: + exists: false + description: new description + +family3: + exists: true + redefine: true + description: new description +``` +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +family1: # a family + + variable1: # a variable + +family2: # a second family + + variable2: # a second variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family1: + variable1: example + family2: + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family1: + variable1: example + family2: + variable2: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_1_0_empty.md b/tests/docs/examples/60_0family_dynamic_1_0_empty.md new file mode 100644 index 0000000..2e4ffaa --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_0_empty.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn: + type: dynamic + variable: rougail.var + vardyn: + description: Dynamic variable + mandatory: false +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + vardyn: example + dynval2: + vardyn: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_1_0_type_empty.md b/tests/docs/examples/60_0family_dynamic_1_0_type_empty.md new file mode 100644 index 0000000..9c34537 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_0_type_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' +var: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn: + _type: dynamic + variable: rougail.var + vardyn: + description: 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/examples/60_0family_dynamic_1_1_empty.md b/tests/docs/examples/60_0family_dynamic_1_1_empty.md new file mode 100644 index 0000000..91c31bf --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_1_1_empty.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn: + type: dynamic + description: A dynamic family + variable: _.var + vardyn: + description: 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/examples/60_0family_dynamic_empty.md b/tests/docs/examples/60_0family_dynamic_empty.md new file mode 100644 index 0000000..0d5e7d2 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_empty.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + mandatory: false + multi: true + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: # A dynamic variable +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynexample: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - example + dynexample: + var: example +``` diff --git a/tests/docs/examples/60_0family_dynamic_jinja_number_empty.md b/tests/docs/examples/60_0family_dynamic_jinja_number_empty.md new file mode 100644 index 0000000..0f88f52 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_jinja_number_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a suffix variable + multi: true + mandatory: false + type: number + test: + - 1 + - 2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: val # a variable inside dynamic family +var2: + description: a variable + default: + jinja: | + {% if rougail.dyn1 is defined %} + {{ rougail.dyn1.var }} + {% endif %} + description: 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/examples/60_0family_dynamic_no_description_empty.md b/tests/docs/examples/60_0family_dynamic_no_description_empty.md new file mode 100644 index 0000000..3f406d7 --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_no_description_empty.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: +``` +# 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/examples/60_0family_dynamic_variable_suffix_empty.md b/tests/docs/examples/60_0family_dynamic_variable_suffix_empty.md new file mode 100644 index 0000000..45d48dc --- /dev/null +++ b/tests/docs/examples/60_0family_dynamic_variable_suffix_empty.md @@ -0,0 +1,43 @@ +--- +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 value # A dynamic variable with suffix {{ identifier }} +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - val1 + - val2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +``` diff --git a/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md new file mode 100644 index 0000000..bf3395a --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a identifier variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + family: + description: a family inside dynamic family + var: + description: a dynamic variable + default: + type: identifier +var2: + description: a varible outside dynamic family + mandatory: false + default: + jinja: | + {% if _.dynval1 is defined %} + {{ _.dynval1.family.var }} + {% endif %} + description: 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/examples/60_2family_dynamic_jinja_fill_sub_group_empty.md b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_empty.md new file mode 100644 index 0000000..ec0f276 --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_jinja_fill_sub_group_empty.md @@ -0,0 +1,60 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + family: # a family + var: # with a variable +var2: + description: a second variable + mandatory: false + default: + jinja: | + {% if _.dynval1 is defined %} + {{ _.dynval1.family.var }} + {% endif %} + description: the value of var +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: 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/examples/60_2family_dynamic_outside_calc_empty.md b/tests/docs/examples/60_2family_dynamic_outside_calc_empty.md new file mode 100644 index 0000000..1f42d41 --- /dev/null +++ b/tests/docs/examples/60_2family_dynamic_outside_calc_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: a suffx variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var1 + var: val # a dynamic variable +newvar: + description: a second variable + mandatory: false + default: + jinja: | + {% if _.dynval1 is defined %} + {{ _.dynval1.var }} + {% endif %} + description: 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/examples/60_5family_dynamic_calc2_empty.md b/tests/docs/examples/60_5family_dynamic_calc2_empty.md new file mode 100644 index 0000000..118d156 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc2_empty.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +var2: # a second variable + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + hidden: + jinja: | + {% if _.var2 == "no" %} + var2 is no + {% endif %} + description: if var2 is no + + vardyn: val # a dynamic variable +``` +# 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/examples/60_5family_dynamic_calc_suffix2_empty.md b/tests/docs/examples/60_5family_dynamic_calc_suffix2_empty.md new file mode 100644 index 0000000..5fdc303 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix2_empty.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: Suffix has value + default: + type: identifier +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix_empty.md b/tests/docs/examples/60_5family_dynamic_calc_suffix_empty.md new file mode 100644 index 0000000..5903985 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix_empty.md @@ -0,0 +1,55 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var1: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +dyn{{ identifier }}: + dynamic: + variable: _.var1 + + var: + description: A dynamic variable + +var2: + description: A variable calculated + default: + variable: rougail.dynval1.var + optional: true +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_suffix_param_empty.md b/tests/docs/examples/60_5family_dynamic_calc_suffix_param_empty.md new file mode 100644 index 0000000..1c247e9 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_suffix_param_empty.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: A identifier variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + var: + description: A dynamic variable + default: + jinja: | + {{ identifier }} + params: + identifier: + type: identifier + description: from suffix +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_calc_variable_empty.md b/tests/docs/examples/60_5family_dynamic_calc_variable_empty.md new file mode 100644 index 0000000..a71c1ee --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_calc_variable_empty.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var1: + description: A suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 +dyn{{ identifier }}: + dynamic: + variable: _.var1 + propertyerror: false + var: + description: A dynamic variable +var2: + description: A variable calculated + default: + variable: _.dynval1.var + optional: true +``` +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/docs/examples/60_5family_dynamic_unknown_suffix_empty.md b/tests/docs/examples/60_5family_dynamic_unknown_suffix_empty.md new file mode 100644 index 0000000..a43e71c --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_unknown_suffix_empty.md @@ -0,0 +1,80 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + - val3 + - val4 + +'{{ identifier }}_dyn': + description: a dynamic family + dynamic: + variable: _.var + + var1: + description: a variable 1 + default: + type: identifier + + var2: + description: a variable 2 + default: + variable: rougail.{{ identifier }}_dyn.var1 + + var3: + description: a variable 3 + default: + variable: _.var1 + + var4: + description: a variable 4 + default: + variable: rougail.val4_dyn.var1 + disabled: + jinja: | + {% if 'val4' not in __.var %} + val4 is not a valid value + {% endif %} +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + - val3 + - val4 + val1_dyn: + var1: val1 + var2: val1 + var3: val1 + var4: val4 + val2_dyn: + var1: val2 + var2: val2 + var3: val2 + var4: val4 + val3_dyn: + var1: val3 + var2: val3 + var3: val3 + var4: val4 + val4_dyn: + var1: val4 + var2: val4 + var3: val4 + var4: val4 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside2_empty.md b/tests/docs/examples/60_5family_dynamic_variable_outside2_empty.md new file mode 100644 index 0000000..e6c9570 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside2_empty.md @@ -0,0 +1,51 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - 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 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var2: + - val1 + - val2 + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside_empty.md b/tests/docs/examples/60_5family_dynamic_variable_outside_empty.md new file mode 100644 index 0000000..8bc4fcb --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_empty.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + var: + description: a variable inside a dynamic family + default: + type: identifier + mandatory: false +var2: + description: a variable + multi: true + default: + variable: rougail.my_dyn_family_{{ identifier }}.var +``` +# 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/examples/60_5family_dynamic_variable_outside_jinja_empty.md b/tests/docs/examples/60_5family_dynamic_variable_outside_jinja_empty.md new file mode 100644 index 0000000..7f9dfbf --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_jinja_empty.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - 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 +``` +# 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/examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md b/tests/docs/examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md new file mode 100644 index 0000000..3448202 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md @@ -0,0 +1,62 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +my_dyn_family_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + propertyerror: false + subdyn_{{ identifier }}: + description: a sub dynamic family + dynamic: + variable: rougail.var + var: + description: a variable inside a sub dynamic family + default: + type: identifier + +var2: + description: a variable + mandatory: false + multi: true + default: + variable: rougail.my_dyn_family_val1.subdyn_{{ identifier }}.var + optional: true +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + subdyn_val1: + var: val1 + subdyn_val2: + var: val2 + my_dyn_family_val2: + subdyn_val1: + var: val1 + subdyn_val2: + var: val2 + var2: + - val1 + - val2 +``` diff --git a/tests/docs/examples/60_5family_dynamic_variable_outside_suffix_empty.md b/tests/docs/examples/60_5family_dynamic_variable_outside_suffix_empty.md new file mode 100644 index 0000000..2cce455 --- /dev/null +++ b/tests/docs/examples/60_5family_dynamic_variable_outside_suffix_empty.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: asuffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +dyn_{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + + var: + description: a variable inside dynamic family + default: + type: identifier + +var2: + description: a variable + mandatory: false + default: + variable: _.dyn_val1.var + optional: true +``` +# 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/examples/60_6family_dynamic_inside_empty.md b/tests/docs/examples/60_6family_dynamic_inside_empty.md new file mode 100644 index 0000000..901c7d6 --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_inside_empty.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +'{{ identifier }}_dyn': + description: a dynamic family + dynamic: + variable: _.var + var1: + description: value is suffix + default: + type: identifier + var2: + description: value is first variable + default: + variable: rougail.{{ identifier }}_dyn.var1 + var3: + description: value is relative first variable + default: + variable: _.var1 + var4: + description: value is first variable of val1 + default: + variable: rougail.val1_dyn.var1 +``` +# 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/examples/60_6family_dynamic_leadership_empty.md b/tests/docs/examples/60_6family_dynamic_leadership_empty.md new file mode 100644 index 0000000..801a80c --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_leadership_empty.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: a suffix variable + multi: true + mandatory: false + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: a dynamic family + dynamic: + variable: _.var + leadership: + description: a leadership + type: leadership + leader: + description: a leader + multi: true + follower1: + description: a follower1 + mandatory: false + follower2: + description: a follower2 + mandatory: false +``` +# 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/examples/60_6family_dynamic_sub_dynamic.md b/tests/docs/examples/60_6family_dynamic_sub_dynamic.md index 16908ef..380efcc 100644 --- a/tests/docs/examples/60_6family_dynamic_sub_dynamic.md +++ b/tests/docs/examples/60_6family_dynamic_sub_dynamic.md @@ -7,13 +7,16 @@ include_toc: true ```yaml --- version: '1.1' + var: # A identifier variable - val1 - val2 + dyn{{ identifier }}: description: A dynamic family dynamic: variable: _.var + var: description: A dynamic variable multi: true @@ -23,19 +26,23 @@ dyn{{ identifier }}: t{{ val }} {% endfor %} description: add 't' to each var value + dyn_{{ identifier }}: description: a Second dynamic variable dynamic: variable: rougail.dyn{{ identifier }}.var + var: description: A variable dynamic default: type: identifier + var_identifier: description: identifier from first family default: type: identifier identifier: 0 + var_identifiers: description: merge identifiers default: diff --git a/tests/docs/examples/60_6family_dynamic_sub_dynamic_1_0.md b/tests/docs/examples/60_6family_dynamic_sub_dynamic_1_0.md new file mode 100644 index 0000000..d4010f0 --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_sub_dynamic_1_0.md @@ -0,0 +1,95 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.0' + +var: + description: A identifier variable + multi: true + default: + - val1 + - val2 + +dyn{{ suffix }}: + description: A dynamic family + type: dynamic + variable: rougail.var + + var: + description: A dynamic variable + multi: true + default: + jinja: | + {% for val in rougail.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + + dyn_{{ suffix }}: + description: a Second dynamic variable + type: dynamic + variable: rougail.dyn{{ suffix }}.var + + var: + description: A variable dynamic + default: + type: identifier + + var_identifier: + description: identifier from first family + default: + type: identifier + identifier: 0 + + var_identifiers: + description: merge identifiers + default: + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: identifier + identifier: 0 + s2: + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val1 + var_identifiers: val1-tval1 + dyn_tval2: + var: tval2 + var_identifier: val1 + var_identifiers: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val2 + var_identifiers: val2-tval1 + dyn_tval2: + var: tval2 + var_identifier: val2 + var_identifiers: val2-tval2 +``` diff --git a/tests/docs/examples/60_6family_dynamic_sub_dynamic_empty.md b/tests/docs/examples/60_6family_dynamic_sub_dynamic_empty.md new file mode 100644 index 0000000..d8c8045 --- /dev/null +++ b/tests/docs/examples/60_6family_dynamic_sub_dynamic_empty.md @@ -0,0 +1,86 @@ +--- +gitea: none +include_toc: true +--- +# dictionaries/rougail/00-base.yml + +```yaml +--- +version: '1.1' + +var: + description: A identifier variable + multi: true + mandatory: false + test: + - val1 + - val2 + +dyn{{ identifier }}: + description: A dynamic family + dynamic: + variable: _.var + + var: + description: A dynamic variable + multi: true + default: + jinja: | + {% for val in __.var %} + t{{ val }} + {% endfor %} + description: add 't' to each var value + + dyn_{{ identifier }}: + description: a Second dynamic variable + dynamic: + variable: rougail.dyn{{ identifier }}.var + + var: + description: A variable dynamic + default: + type: identifier + + var_identifier: + description: identifier from first family + default: + type: identifier + identifier: 0 + + var_identifiers: + description: merge identifiers + default: + jinja: | + {{ s1 }}-{{ s2 }} + params: + s1: + type: identifier + identifier: 0 + s2: + type: identifier + identifier: 1 + description: join identifier 1 et identifier 2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - example + dyn_example: + var: example + var_identifier: val1 + var_identifiers: val1-example + dynval2: + var: + - example + dyn_example: + var: example + var_identifier: val2 + var_identifiers: val2-example +``` diff --git a/tests/docs/base/00_0empty.adoc b/tests/results/test/00_0empty.adoc similarity index 100% rename from tests/docs/base/00_0empty.adoc rename to tests/results/test/00_0empty.adoc diff --git a/tests/docs/base/00_0empty.json b/tests/results/test/00_0empty.json similarity index 100% rename from tests/docs/base/00_0empty.json rename to tests/results/test/00_0empty.json diff --git a/tests/docs/base/00_0empty.md b/tests/results/test/00_0empty.md similarity index 100% rename from tests/docs/base/00_0empty.md rename to tests/results/test/00_0empty.md diff --git a/tests/docs/base/00_0empty.sh b/tests/results/test/00_0empty.sh similarity index 100% rename from tests/docs/base/00_0empty.sh rename to tests/results/test/00_0empty.sh diff --git a/tests/results/test/00_0version_underscore.adoc b/tests/results/test/00_0version_underscore.adoc new file mode 100644 index 0000000..ee770e1 --- /dev/null +++ b/tests/results/test/00_0version_underscore.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**version** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/00_0version_underscore.json b/tests/results/test/00_0version_underscore.json new file mode 100644 index 0000000..3cba9c9 --- /dev/null +++ b/tests/results/test/00_0version_underscore.json @@ -0,0 +1 @@ +{"version": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["version"], "names": ["version"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_0version_underscore.md b/tests/results/test/00_0version_underscore.md new file mode 100644 index 0000000..cdbf3e6 --- /dev/null +++ b/tests/results/test/00_0version_underscore.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/00_0version_underscore.sh b/tests/results/test/00_0version_underscore.sh new file mode 100644 index 0000000..4452b03 --- /dev/null +++ b/tests/results/test/00_0version_underscore.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + version + string basic mandatory A variable. + diff --git a/tests/results/test/00_1empty_variable.adoc b/tests/results/test/00_1empty_variable.adoc new file mode 100644 index 0000000..f62cc5c --- /dev/null +++ b/tests/results/test/00_1empty_variable.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**empty** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Empty. +|==== + diff --git a/tests/results/test/00_1empty_variable.json b/tests/results/test/00_1empty_variable.json new file mode 100644 index 0000000..4bb7826 --- /dev/null +++ b/tests/results/test/00_1empty_variable.json @@ -0,0 +1 @@ +{"empty": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["empty"], "names": ["empty"]}} \ No newline at end of file diff --git a/tests/results/test/00_1empty_variable.md b/tests/results/test/00_1empty_variable.md new file mode 100644 index 0000000..6f2b41d --- /dev/null +++ b/tests/results/test/00_1empty_variable.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | + diff --git a/tests/results/test/00_1empty_variable.sh b/tests/results/test/00_1empty_variable.sh new file mode 100644 index 0000000..d67df1a --- /dev/null +++ b/tests/results/test/00_1empty_variable.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + empty + string basic mandatory Empty. + diff --git a/tests/results/test/00_2default_calculated.adoc b/tests/results/test/00_2default_calculated.adoc new file mode 100644 index 0000000..d1200f3 --- /dev/null +++ b/tests/results/test/00_2default_calculated.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of var1. +|==== + diff --git a/tests/results/test/00_2default_calculated.json b/tests/results/test/00_2default_calculated.json new file mode 100644 index 0000000..2fb7ffd --- /dev/null +++ b/tests/results/test/00_2default_calculated.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_2default_calculated.md b/tests/results/test/00_2default_calculated.md new file mode 100644 index 0000000..7617e95 --- /dev/null +++ b/tests/results/test/00_2default_calculated.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/00_2default_calculated.sh b/tests/results/test/00_2default_calculated.sh new file mode 100644 index 0000000..450881a --- /dev/null +++ b/tests/results/test/00_2default_calculated.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string standard mandatory unique A second variable. + multiple + Default: the value of var1. + diff --git a/tests/results/test/00_2default_calculated_multi.adoc b/tests/results/test/00_2default_calculated_multi.adoc new file mode 100644 index 0000000..7f6a6d1 --- /dev/null +++ b/tests/results/test/00_2default_calculated_multi.adoc @@ -0,0 +1,23 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* no +* yes +* maybe +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: the value of _.var1. +|==== + diff --git a/tests/results/test/00_2default_calculated_multi.json b/tests/results/test/00_2default_calculated_multi.json new file mode 100644 index 0000000..5354ed1 --- /dev/null +++ b/tests/results/test/00_2default_calculated_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes", "maybe"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of _.var1.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_2default_calculated_multi.md b/tests/results/test/00_2default_calculated_multi.md new file mode 100644 index 0000000..ab128ba --- /dev/null +++ b/tests/results/test/00_2default_calculated_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/00_2default_calculated_multi.sh b/tests/results/test/00_2default_calculated_multi.sh new file mode 100644 index 0000000..b57f98f --- /dev/null +++ b/tests/results/test/00_2default_calculated_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A first variable. + multiple + Default: + + + • no + • yes + • maybe + | | var2 string standard mandatory unique multiple + | A second variable. Default: the value of _.var1. + | diff --git a/tests/results/test/00_2default_calculated_variable_transitive.adoc b/tests/results/test/00_2default_calculated_variable_transitive.adoc new file mode 100644 index 0000000..ad632c9 --- /dev/null +++ b/tests/results/test/00_2default_calculated_variable_transitive.adoc @@ -0,0 +1,20 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `basic` `mandatory` `unique` `multiple` | +A first variable. + +**Validator**: the domain name can be an IP +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Validator**: the domain name can be an IP + +**Default**: the value of the variable "var1". +|==== + diff --git a/tests/results/test/00_2default_calculated_variable_transitive.json b/tests/results/test/00_2default_calculated_variable_transitive.json new file mode 100644 index 0000000..9f58863 --- /dev/null +++ b/tests/results/test/00_2default_calculated_variable_transitive.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "the value of the variable \"var1\".", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["the domain name can be an IP"], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_2default_calculated_variable_transitive.md b/tests/results/test/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..bb16a60 --- /dev/null +++ b/tests/results/test/00_2default_calculated_variable_transitive.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                           | Description                                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | +| **var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "var1". | + diff --git a/tests/results/test/00_2default_calculated_variable_transitive.sh b/tests/results/test/00_2default_calculated_variable_transitive.sh new file mode 100644 index 0000000..f847433 --- /dev/null +++ b/tests/results/test/00_2default_calculated_variable_transitive.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + domainname basic mandatory unique A first variable. + multiple + Validator: the domain name can be an + IP + var2 + domainname standard mandatory unique A second variable. + multiple + Validator: the domain name can be an + IP + Default: the value of the variable + "var1". + diff --git a/tests/results/test/00_4load_subfolder.adoc b/tests/results/test/00_4load_subfolder.adoc new file mode 100644 index 0000000..3b37d77 --- /dev/null +++ b/tests/results/test/00_4load_subfolder.adoc @@ -0,0 +1,17 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/00_4load_subfolder.json b/tests/results/test/00_4load_subfolder.json new file mode 100644 index 0000000..67020fa --- /dev/null +++ b/tests/results/test/00_4load_subfolder.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_4load_subfolder.md b/tests/results/test/00_4load_subfolder.md new file mode 100644 index 0000000..c9e14b2 --- /dev/null +++ b/tests/results/test/00_4load_subfolder.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/00_4load_subfolder.sh b/tests/results/test/00_4load_subfolder.sh new file mode 100644 index 0000000..58051b2 --- /dev/null +++ b/tests/results/test/00_4load_subfolder.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A variable. + var2 + string basic mandatory A variable. + diff --git a/tests/results/test/00_5load_notype.adoc b/tests/results/test/00_5load_notype.adoc new file mode 100644 index 0000000..3bacc76 --- /dev/null +++ b/tests/results/test/00_5load_notype.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**without_type** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: non +|==== + diff --git a/tests/results/test/00_5load_notype.json b/tests/results/test/00_5load_notype.json new file mode 100644 index 0000000..57bf6a5 --- /dev/null +++ b/tests/results/test/00_5load_notype.json @@ -0,0 +1 @@ +{"without_type": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["without_type"], "names": ["without_type"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_5load_notype.md b/tests/results/test/00_5load_notype.md new file mode 100644 index 0000000..04fc4fa --- /dev/null +++ b/tests/results/test/00_5load_notype.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | + diff --git a/tests/results/test/00_5load_notype.sh b/tests/results/test/00_5load_notype.sh new file mode 100644 index 0000000..bf5b03f --- /dev/null +++ b/tests/results/test/00_5load_notype.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + without_type + string standard mandatory A variable. + Default: non + diff --git a/tests/results/test/00_6boolean.adoc b/tests/results/test/00_6boolean.adoc new file mode 100644 index 0000000..0323bc5 --- /dev/null +++ b/tests/results/test/00_6boolean.adoc @@ -0,0 +1,43 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The first variable. + +**Default**: true +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The second variable. + +**Default**: true +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The third variable. + +**Default**: true +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The forth variable. + +**Default**: false +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The fifth variable. + +**Default**: false +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The sixth variable. + +**Default**: false +|==== + diff --git a/tests/results/test/00_6boolean.json b/tests/results/test/00_6boolean.json new file mode 100644 index 0000000..a0be1c6 --- /dev/null +++ b/tests/results/test/00_6boolean.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6boolean.md b/tests/results/test/00_6boolean.md new file mode 100644 index 0000000..91fb783 --- /dev/null +++ b/tests/results/test/00_6boolean.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6boolean.sh b/tests/results/test/00_6boolean.sh new file mode 100644 index 0000000..bb3ab56 --- /dev/null +++ b/tests/results/test/00_6boolean.sh @@ -0,0 +1,38 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + boolean standard mandatory The first variable. + Default: true + var2 + boolean standard mandatory The second variable. + Default: true + var3 + boolean standard mandatory The third variable. + Default: true + var4 + boolean standard mandatory The forth variable. + Default: false + var5 + boolean standard mandatory The fifth variable. + Default: false + var6 + boolean standard mandatory The sixth variable. + Default: false + diff --git a/tests/results/test/00_6boolean_no_mandatory.adoc b/tests/results/test/00_6boolean_no_mandatory.adoc new file mode 100644 index 0000000..2348b24 --- /dev/null +++ b/tests/results/test/00_6boolean_no_mandatory.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` | +A variable. + +**Default**: true +|==== + diff --git a/tests/results/test/00_6boolean_no_mandatory.json b/tests/results/test/00_6boolean_no_mandatory.json new file mode 100644 index 0000000..40e4c7c --- /dev/null +++ b/tests/results/test/00_6boolean_no_mandatory.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6boolean_no_mandatory.md b/tests/results/test/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..07c0bbd --- /dev/null +++ b/tests/results/test/00_6boolean_no_mandatory.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | + diff --git a/tests/results/test/00_6boolean_no_mandatory.sh b/tests/results/test/00_6boolean_no_mandatory.sh new file mode 100644 index 0000000..89b2262 --- /dev/null +++ b/tests/results/test/00_6boolean_no_mandatory.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                Description            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + boolean standard A variable. + Default: true + diff --git a/tests/results/test/00_6choice.adoc b/tests/results/test/00_6choice.adoc new file mode 100644 index 0000000..932d16d --- /dev/null +++ b/tests/results/test/00_6choice.adoc @@ -0,0 +1,68 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The first variable. + +**Choices**: + +* a +* b +* c +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +The second variable. + +**Choices**: + +* a +* b +* c +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The third variable. + +**Choices**: + +* a +* b +* c +* null +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` | +The forth variable. + +**Choices**: + +* null +* b +* c +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The fifth variable. + +**Choices**: + +* a ← (default) +* b +* c +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +The sixth variable. + +**Choices**: + +* 1 ← (default) +* 2 +* 3 +|==== + diff --git a/tests/results/test/00_6choice.json b/tests/results/test/00_6choice.json new file mode 100644 index 0000000..d4f29d8 --- /dev/null +++ b/tests/results/test/00_6choice.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": ["a", "b", "c", null], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}], "choices": [null, "b", "c"], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a ← (default)", "b", "c"], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["1 ← (default)", 2, 3], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6choice.md b/tests/results/test/00_6choice.md new file mode 100644 index 0000000..c13da2e --- /dev/null +++ b/tests/results/test/00_6choice.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6choice.sh b/tests/results/test/00_6choice.sh new file mode 100644 index 0000000..8b832d8 --- /dev/null +++ b/tests/results/test/00_6choice.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + choice basic mandatory The first variable. + Choices: + + + • a + • b + • c + | | var2 choice basic mandatory + | The second variable. Choices: + • a + • b + • c + | | var3 choice standard + | The third variable. Choices: + • a + • b + • c + • null + | | var4 choice standard + | The forth variable. Choices: + • null + • b + • c + | | var5 choice standard mandatory + | The fifth variable. Choices: + • a ← (default) + • b + • c + | | var6 choice standard mandatory + | The sixth variable. Choices: + • 1 ← (default) + • 2 + • 3 + | diff --git a/tests/results/test/00_6choice_calculation.adoc b/tests/results/test/00_6choice_calculation.adoc new file mode 100644 index 0000000..f61e223 --- /dev/null +++ b/tests/results/test/00_6choice_calculation.adoc @@ -0,0 +1,14 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choices is 0 to 9. + +**Default**: 9 +|==== + diff --git a/tests/results/test/00_6choice_calculation.json b/tests/results/test/00_6choice_calculation.json new file mode 100644 index 0000000..9ec1ae9 --- /dev/null +++ b/tests/results/test/00_6choice_calculation.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choices is 0 to 9.", "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6choice_calculation.md b/tests/results/test/00_6choice_calculation.md new file mode 100644 index 0000000..4f420f1 --- /dev/null +++ b/tests/results/test/00_6choice_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6choice_calculation.sh b/tests/results/test/00_6choice_calculation.sh new file mode 100644 index 0000000..97ea281 --- /dev/null +++ b/tests/results/test/00_6choice_calculation.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A variable. + Choices: choices is 0 to 9. + Default: 9 + diff --git a/tests/results/test/00_6choice_variable.adoc b/tests/results/test/00_6choice_variable.adoc new file mode 100644 index 0000000..eb1a5ec --- /dev/null +++ b/tests/results/test/00_6choice_variable.adoc @@ -0,0 +1,24 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Default**: + +* a +* b +* c +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A first variable. + +**Choices**: the value of the variable "var1". + +**Default**: a +|==== + diff --git a/tests/results/test/00_6choice_variable.json b/tests/results/test/00_6choice_variable.json new file mode 100644 index 0000000..92403d0 --- /dev/null +++ b/tests/results/test/00_6choice_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}, "var2": {"type": "variable", "default": "a", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"var1\".", "paths": ["var2"], "names": ["var2"], "descriptions": ["A first variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6choice_variable.md b/tests/results/test/00_6choice_variable.md new file mode 100644 index 0000000..75ebe84 --- /dev/null +++ b/tests/results/test/00_6choice_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6choice_variable.sh b/tests/results/test/00_6choice_variable.sh new file mode 100644 index 0000000..06d1c74 --- /dev/null +++ b/tests/results/test/00_6choice_variable.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A second variable. + multiple + Default: + + + • a + • b + • c + | | var2 choice standard mandatory + | A first variable. Choices: the value of the variable "var1". Default: a + | diff --git a/tests/results/test/00_6custom.adoc b/tests/results/test/00_6custom.adoc new file mode 100644 index 0000000..5bd1c83 --- /dev/null +++ b/tests/results/test/00_6custom.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**custom1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` | +The first variable. +| + +**custom2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` | +The seconf variable. + +**Default**: value +|==== + diff --git a/tests/results/test/00_6custom.json b/tests/results/test/00_6custom.json new file mode 100644 index 0000000..9e6de75 --- /dev/null +++ b/tests/results/test/00_6custom.json @@ -0,0 +1 @@ +{"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["custom1"], "names": ["custom1"], "descriptions": ["The first variable."]}, "custom2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["custom2"], "names": ["custom2"], "descriptions": ["The seconf variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6custom.md b/tests/results/test/00_6custom.md new file mode 100644 index 0000000..33e10bd --- /dev/null +++ b/tests/results/test/00_6custom.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6custom.sh b/tests/results/test/00_6custom.sh new file mode 100644 index 0000000..aafffa6 --- /dev/null +++ b/tests/results/test/00_6custom.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + custom1 + custom basic mandatory The first variable. + custom2 + custom standard mandatory The seconf variable. + Default: value + diff --git a/tests/results/test/00_6domainname.adoc b/tests/results/test/00_6domainname.adoc new file mode 100644 index 0000000..2bf92e8 --- /dev/null +++ b/tests/results/test/00_6domainname.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Default**: my.domain.name +|==== + diff --git a/tests/results/test/00_6domainname.json b/tests/results/test/00_6domainname.json new file mode 100644 index 0000000..8063201 --- /dev/null +++ b/tests/results/test/00_6domainname.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6domainname.md b/tests/results/test/00_6domainname.md new file mode 100644 index 0000000..32e4239 --- /dev/null +++ b/tests/results/test/00_6domainname.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6domainname.sh b/tests/results/test/00_6domainname.sh new file mode 100644 index 0000000..abb57e8 --- /dev/null +++ b/tests/results/test/00_6domainname.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + domainname standard mandatory A domain name variable. + Default: my.domain.name + diff --git a/tests/results/test/00_6domainname_params.adoc b/tests/results/test/00_6domainname_params.adoc new file mode 100644 index 0000000..94bd2f0 --- /dev/null +++ b/tests/results/test/00_6domainname_params.adoc @@ -0,0 +1,14 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[domainname]` `standard` `mandatory` | +A domain name variable. + +**Validator**: the domain name can be an IP + +**Default**: my.domain.name +|==== + diff --git a/tests/results/test/00_6domainname_params.json b/tests/results/test/00_6domainname_params.json new file mode 100644 index 0000000..f378c6a --- /dev/null +++ b/tests/results/test/00_6domainname_params.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "my.domain.name", "properties": [{"type": "type", "name": "domainname"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the domain name can be an IP"], "paths": ["variable"], "names": ["variable"], "descriptions": ["A domain name variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6domainname_params.md b/tests/results/test/00_6domainname_params.md new file mode 100644 index 0000000..b542b91 --- /dev/null +++ b/tests/results/test/00_6domainname_params.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6domainname_params.sh b/tests/results/test/00_6domainname_params.sh new file mode 100644 index 0000000..af109cc --- /dev/null +++ b/tests/results/test/00_6domainname_params.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + domainname standard mandatory A domain name variable. + Validator: the domain name can be an + IP + Default: my.domain.name + diff --git a/tests/results/test/00_6float.adoc b/tests/results/test/00_6float.adoc new file mode 100644 index 0000000..dad33de --- /dev/null +++ b/tests/results/test/00_6float.adoc @@ -0,0 +1,43 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The first variable. + +**Default**: 0.0 +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The second variable. + +**Default**: 0.0 +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The third variable. + +**Default**: 0.0 +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The forth variable. + +**Default**: 10.1 +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10.1 +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10.1 +|==== + diff --git a/tests/results/test/00_6float.json b/tests/results/test/00_6float.json new file mode 100644 index 0000000..c06ac77 --- /dev/null +++ b/tests/results/test/00_6float.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0.0, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10.1, "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6float.md b/tests/results/test/00_6float.md new file mode 100644 index 0000000..a5d8c76 --- /dev/null +++ b/tests/results/test/00_6float.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6float.sh b/tests/results/test/00_6float.sh new file mode 100644 index 0000000..1b4be68 --- /dev/null +++ b/tests/results/test/00_6float.sh @@ -0,0 +1,38 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                          Description                      + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + float standard mandatory The first variable. + Default: 0.0 + var2 + float standard mandatory The second variable. + Default: 0.0 + var3 + float standard mandatory The third variable. + Default: 0.0 + var4 + float standard mandatory The forth variable. + Default: 10.1 + var5 + float standard mandatory The fifth variable. + Default: 10.1 + var6 + float standard mandatory The sixth variable. + Default: 10.1 + diff --git a/tests/results/test/00_6number.adoc b/tests/results/test/00_6number.adoc new file mode 100644 index 0000000..7034faa --- /dev/null +++ b/tests/results/test/00_6number.adoc @@ -0,0 +1,43 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The first variable. + +**Default**: 0 +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The second variable. + +**Default**: 0 +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The third variable. + +**Default**: 0 +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +This forth variable. + +**Default**: 10 +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The fifth variable. + +**Default**: 10 +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +The sixth variable. + +**Default**: 10 +|==== + diff --git a/tests/results/test/00_6number.json b/tests/results/test/00_6number.json new file mode 100644 index 0000000..87df4c8 --- /dev/null +++ b/tests/results/test/00_6number.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "default": 0, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["This forth variable."]}, "var5": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6number.md b/tests/results/test/00_6number.md new file mode 100644 index 0000000..c8414a5 --- /dev/null +++ b/tests/results/test/00_6number.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6number.sh b/tests/results/test/00_6number.sh new file mode 100644 index 0000000..3313869 --- /dev/null +++ b/tests/results/test/00_6number.sh @@ -0,0 +1,38 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + number standard mandatory The first variable. + Default: 0 + var2 + number standard mandatory The second variable. + Default: 0 + var3 + number standard mandatory The third variable. + Default: 0 + var4 + number standard mandatory This forth variable. + Default: 10 + var5 + number standard mandatory The fifth variable. + Default: 10 + var6 + number standard mandatory The sixth variable. + Default: 10 + diff --git a/tests/results/test/00_6port.adoc b/tests/results/test/00_6port.adoc new file mode 100644 index 0000000..d259fee --- /dev/null +++ b/tests/results/test/00_6port.adoc @@ -0,0 +1,24 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | +A port variable. +| + +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +A port variable with default value. + +**Default**: 8080 +| + +**variable3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | +A port variable with integer default value. + +**Default**: 8080 +|==== + diff --git a/tests/results/test/00_6port.json b/tests/results/test/00_6port.json new file mode 100644 index 0000000..99ef63a --- /dev/null +++ b/tests/results/test/00_6port.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A port variable."]}, "variable2": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A port variable with default value."]}, "variable3": {"type": "variable", "default": "8080", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable3"], "names": ["variable3"], "descriptions": ["A port variable with integer default value."]}} \ No newline at end of file diff --git a/tests/results/test/00_6port.md b/tests/results/test/00_6port.md new file mode 100644 index 0000000..ad37dd3 --- /dev/null +++ b/tests/results/test/00_6port.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable. | +| **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | +| **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | + diff --git a/tests/results/test/00_6port.sh b/tests/results/test/00_6port.sh new file mode 100644 index 0000000..50bc115 --- /dev/null +++ b/tests/results/test/00_6port.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + port basic mandatory A port variable. + variable2 + port standard mandatory A port variable with default value. + Default: 8080 + variable3 + port standard mandatory A port variable with integer default + value. + Default: 8080 + diff --git a/tests/results/test/00_6regexp.adoc b/tests/results/test/00_6regexp.adoc new file mode 100644 index 0000000..aeb37cc --- /dev/null +++ b/tests/results/test/00_6regexp.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[regexp]` `standard` `mandatory` | +A first variable. + +**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" + +**Default**: #a1a1a1 + +**Examples**: + +* '#b1b1b1' +* '#b2b2b2' +|==== + diff --git a/tests/results/test/00_6regexp.json b/tests/results/test/00_6regexp.json new file mode 100644 index 0000000..4054d25 --- /dev/null +++ b/tests/results/test/00_6regexp.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "#a1a1a1", "properties": [{"type": "type", "name": "regexp"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["text based with regular expressions \"^#(?:[0-9a-f]{3}){1,2}$\""], "paths": ["var"], "names": ["var"], "descriptions": ["A first variable."], "examples": ["#b1b1b1", "#b2b2b2"]}} \ No newline at end of file diff --git a/tests/results/test/00_6regexp.md b/tests/results/test/00_6regexp.md new file mode 100644 index 0000000..1a77278 --- /dev/null +++ b/tests/results/test/00_6regexp.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | + diff --git a/tests/results/test/00_6regexp.sh b/tests/results/test/00_6regexp.sh new file mode 100644 index 0000000..16697e3 --- /dev/null +++ b/tests/results/test/00_6regexp.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + regexp standard mandatory A first variable. + Validator: text based with regular + expressions "^#(?:[0-9a-f]{3}){1,2}$" + Default: #a1a1a1 + Examples: + + + • #b1b1b1 + • #b2b2b2 + | diff --git a/tests/results/test/00_6string.adoc b/tests/results/test/00_6string.adoc new file mode 100644 index 0000000..6e70e10 --- /dev/null +++ b/tests/results/test/00_6string.adoc @@ -0,0 +1,40 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The forth variable. + +**Default**: value +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The fifth variable. + +**Default**: value +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The sixth variable. + +**Default**: value +|==== + diff --git a/tests/results/test/00_6string.json b/tests/results/test/00_6string.json new file mode 100644 index 0000000..c46728b --- /dev/null +++ b/tests/results/test/00_6string.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."]}, "var5": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."]}, "var6": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6string.md b/tests/results/test/00_6string.md new file mode 100644 index 0000000..a2a0b04 --- /dev/null +++ b/tests/results/test/00_6string.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_6string.sh b/tests/results/test/00_6string.sh new file mode 100644 index 0000000..e4a0a70 --- /dev/null +++ b/tests/results/test/00_6string.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + var2 + string basic mandatory The second variable. + var3 + string basic mandatory The third variable. + var4 + string standard mandatory The forth variable. + Default: value + var5 + string standard mandatory The fifth variable. + Default: value + var6 + string standard mandatory The sixth variable. + Default: value + diff --git a/tests/results/test/00_7choice_quote.adoc b/tests/results/test/00_7choice_quote.adoc new file mode 100644 index 0000000..c8800aa --- /dev/null +++ b/tests/results/test/00_7choice_quote.adoc @@ -0,0 +1,17 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* quote' ← (default) +* quote" +* quote"' +|==== + diff --git a/tests/results/test/00_7choice_quote.json b/tests/results/test/00_7choice_quote.json new file mode 100644 index 0000000..00c21e8 --- /dev/null +++ b/tests/results/test/00_7choice_quote.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["quote' ← (default)", "quote\"", "quote\"'"], "paths": ["var"], "names": ["var"], "descriptions": ["A choice."]}} \ No newline at end of file diff --git a/tests/results/test/00_7choice_quote.md b/tests/results/test/00_7choice_quote.md new file mode 100644 index 0000000..0750ab9 --- /dev/null +++ b/tests/results/test/00_7choice_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | + diff --git a/tests/results/test/00_7choice_quote.sh b/tests/results/test/00_7choice_quote.sh new file mode 100644 index 0000000..2137f8e --- /dev/null +++ b/tests/results/test/00_7choice_quote.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A choice. + Choices: + + + • quote' ← (default) + • quote" + • quote"' + | diff --git a/tests/results/test/00_7help_quote.adoc b/tests/results/test/00_7help_quote.adoc new file mode 100644 index 0000000..3d33090 --- /dev/null +++ b/tests/results/test/00_7help_quote.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +Message with '. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. + +Message with ". +|==== + diff --git a/tests/results/test/00_7help_quote.json b/tests/results/test/00_7help_quote.json new file mode 100644 index 0000000..81b0048 --- /dev/null +++ b/tests/results/test/00_7help_quote.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "help": ["Message with '."], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "help": ["Message with \"."], "descriptions": ["The second variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_7help_quote.md b/tests/results/test/00_7help_quote.md new file mode 100644 index 0000000..a84479d --- /dev/null +++ b/tests/results/test/00_7help_quote.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 ". | + diff --git a/tests/results/test/00_7help_quote.sh b/tests/results/test/00_7help_quote.sh new file mode 100644 index 0000000..cbdab1c --- /dev/null +++ b/tests/results/test/00_7help_quote.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + Message with '. + var2 + string basic mandatory The second variable. + Message with ". + diff --git a/tests/results/test/00_7value_doublequote.adoc b/tests/results/test/00_7value_doublequote.adoc new file mode 100644 index 0000000..62b9f72 --- /dev/null +++ b/tests/results/test/00_7value_doublequote.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote" +|==== + diff --git a/tests/results/test/00_7value_doublequote.json b/tests/results/test/00_7value_doublequote.json new file mode 100644 index 0000000..0c66bd9 --- /dev/null +++ b/tests/results/test/00_7value_doublequote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_7value_doublequote.md b/tests/results/test/00_7value_doublequote.md new file mode 100644 index 0000000..e9eafb9 --- /dev/null +++ b/tests/results/test/00_7value_doublequote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | + diff --git a/tests/results/test/00_7value_doublequote.sh b/tests/results/test/00_7value_doublequote.sh new file mode 100644 index 0000000..8a6df0e --- /dev/null +++ b/tests/results/test/00_7value_doublequote.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote" + diff --git a/tests/results/test/00_7value_doublequote2.adoc b/tests/results/test/00_7value_doublequote2.adoc new file mode 100644 index 0000000..5088723 --- /dev/null +++ b/tests/results/test/00_7value_doublequote2.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote'" +|==== + diff --git a/tests/results/test/00_7value_doublequote2.json b/tests/results/test/00_7value_doublequote2.json new file mode 100644 index 0000000..bd82e61 --- /dev/null +++ b/tests/results/test/00_7value_doublequote2.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote'\"", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_7value_doublequote2.md b/tests/results/test/00_7value_doublequote2.md new file mode 100644 index 0000000..2a32c01 --- /dev/null +++ b/tests/results/test/00_7value_doublequote2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | + diff --git a/tests/results/test/00_7value_doublequote2.sh b/tests/results/test/00_7value_doublequote2.sh new file mode 100644 index 0000000..af6daae --- /dev/null +++ b/tests/results/test/00_7value_doublequote2.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote'" + diff --git a/tests/results/test/00_7value_doublequote3.adoc b/tests/results/test/00_7value_doublequote3.adoc new file mode 100644 index 0000000..8a8e081 --- /dev/null +++ b/tests/results/test/00_7value_doublequote3.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote\"\' +|==== + diff --git a/tests/results/test/00_7value_doublequote3.json b/tests/results/test/00_7value_doublequote3.json new file mode 100644 index 0000000..a9bc9b6 --- /dev/null +++ b/tests/results/test/00_7value_doublequote3.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote\\\"\\'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_7value_doublequote3.md b/tests/results/test/00_7value_doublequote3.md new file mode 100644 index 0000000..f22d5cd --- /dev/null +++ b/tests/results/test/00_7value_doublequote3.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | + diff --git a/tests/results/test/00_7value_doublequote3.sh b/tests/results/test/00_7value_doublequote3.sh new file mode 100644 index 0000000..41f9182 --- /dev/null +++ b/tests/results/test/00_7value_doublequote3.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote"' + diff --git a/tests/results/test/00_7value_quote.adoc b/tests/results/test/00_7value_quote.adoc new file mode 100644 index 0000000..244de53 --- /dev/null +++ b/tests/results/test/00_7value_quote.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: quote' +|==== + diff --git a/tests/results/test/00_7value_quote.json b/tests/results/test/00_7value_quote.json new file mode 100644 index 0000000..d498356 --- /dev/null +++ b/tests/results/test/00_7value_quote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "quote'", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_7value_quote.md b/tests/results/test/00_7value_quote.md new file mode 100644 index 0000000..4e38d4a --- /dev/null +++ b/tests/results/test/00_7value_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | + diff --git a/tests/results/test/00_7value_quote.sh b/tests/results/test/00_7value_quote.sh new file mode 100644 index 0000000..1b30eb2 --- /dev/null +++ b/tests/results/test/00_7value_quote.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: quote' + diff --git a/tests/results/test/00_8calculation_information.adoc b/tests/results/test/00_8calculation_information.adoc new file mode 100644 index 0000000..a770072 --- /dev/null +++ b/tests/results/test/00_8calculation_information.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get information test_information. +|==== + diff --git a/tests/results/test/00_8calculation_information.json b/tests/results/test/00_8calculation_information.json new file mode 100644 index 0000000..933f75c --- /dev/null +++ b/tests/results/test/00_8calculation_information.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_8calculation_information.md b/tests/results/test/00_8calculation_information.md new file mode 100644 index 0000000..17de74d --- /dev/null +++ b/tests/results/test/00_8calculation_information.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | + diff --git a/tests/results/test/00_8calculation_information.sh b/tests/results/test/00_8calculation_information.sh new file mode 100644 index 0000000..a3af09f --- /dev/null +++ b/tests/results/test/00_8calculation_information.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: get information + test_information. + diff --git a/tests/results/test/00_8test.adoc b/tests/results/test/00_8test.adoc new file mode 100644 index 0000000..99b3d53 --- /dev/null +++ b/tests/results/test/00_8test.adoc @@ -0,0 +1,55 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. + +**Example**: test +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The second variable. + +**Default**: value + +**Example**: test +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. + +**Examples**: + +* test1 +* test2 +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +The forth variable. + +**Examples**: + +* null +* test1 +* test2 +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The fifth variable. + +**Default**: true + +**Example**: false +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The sixth variable. + +**Examples**: + +* test1 +* test2 +|==== + diff --git a/tests/results/test/00_8test.json b/tests/results/test/00_8test.json new file mode 100644 index 0000000..471744e --- /dev/null +++ b/tests/results/test/00_8test.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "examples": ["test"]}, "var2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "examples": ["test"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "examples": ["test1", "test2"]}, "var4": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "examples": [null, "test1", "test2"]}, "var5": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "examples": [false]}, "var6": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true, "examples": ["test1", "test2"]}} \ No newline at end of file diff --git a/tests/results/test/00_8test.md b/tests/results/test/00_8test.md new file mode 100644 index 0000000..0399c0a --- /dev/null +++ b/tests/results/test/00_8test.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# 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.
**Examples**:
- test1
- test2 | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Examples**:
- null
- test1
- test2 | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | + diff --git a/tests/results/test/00_8test.sh b/tests/results/test/00_8test.sh new file mode 100644 index 0000000..1ab9bb3 --- /dev/null +++ b/tests/results/test/00_8test.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory The first variable. + Example: test + var2 + string standard mandatory The second variable. + Default: value + Example: test + var3 + string basic mandatory The third variable. + Examples: + + + • test1 + • test2 + | | var4 string standard + | The forth variable. Examples: + • null + • test1 + • test2 + | | var5 boolean standard mandatory + | The fifth variable. Default: true Example: false + | | var6 string basic mandatory unique multiple + | The sixth variable. Examples: + • test1 + • test2 + | diff --git a/tests/results/test/00_9choice_variable_multi.adoc b/tests/results/test/00_9choice_variable_multi.adoc new file mode 100644 index 0000000..ddafdb4 --- /dev/null +++ b/tests/results/test/00_9choice_variable_multi.adoc @@ -0,0 +1,25 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` `unique` `multiple` | +A first variable. + +**Choices**: + +* val1 +* val2 +| + +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `unique` `multiple` | +A second variable. + +**Choices**: + +* val1 +* val2 +|==== + diff --git a/tests/results/test/00_9choice_variable_multi.json b/tests/results/test/00_9choice_variable_multi.json new file mode 100644 index 0000000..4b80b35 --- /dev/null +++ b/tests/results/test/00_9choice_variable_multi.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "choices": ["val1", "val2"], "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_9choice_variable_multi.md b/tests/results/test/00_9choice_variable_multi.md new file mode 100644 index 0000000..af7b81c --- /dev/null +++ b/tests/results/test/00_9choice_variable_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| 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 | + diff --git a/tests/results/test/00_9choice_variable_multi.sh b/tests/results/test/00_9choice_variable_multi.sh new file mode 100644 index 0000000..ed2d833 --- /dev/null +++ b/tests/results/test/00_9choice_variable_multi.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + choice basic mandatory unique A first variable. + multiple + Choices: + + + • val1 + • val2 + | | variable2 choice standard unique multiple + | A second variable. Choices: + • val1 + • val2 + | diff --git a/tests/results/test/00_9choice_variables.adoc b/tests/results/test/00_9choice_variables.adoc new file mode 100644 index 0000000..5f25c3b --- /dev/null +++ b/tests/results/test/00_9choice_variables.adoc @@ -0,0 +1,30 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**source_variable_1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The first source variable. + +**Default**: val1 +| + +**source_variable_2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The second source variable. + +**Default**: val2 +| + +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: + +* the value of the variable "source_variable_1". +* the value of the variable "source_variable_2". + +**Default**: val1 +|==== + diff --git a/tests/results/test/00_9choice_variables.json b/tests/results/test/00_9choice_variables.json new file mode 100644 index 0000000..2678cbd --- /dev/null +++ b/tests/results/test/00_9choice_variables.json @@ -0,0 +1 @@ +{"source_variable_1": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["source_variable_1"], "names": ["source_variable_1"], "descriptions": ["The first source variable."]}, "source_variable_2": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["source_variable_2"], "names": ["source_variable_2"], "descriptions": ["The second source variable."]}, "my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": ["the value of the variable \"source_variable_1\".", "the value of the variable \"source_variable_2\"."], "paths": ["my_variable"], "names": ["my_variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9choice_variables.md b/tests/results/test/00_9choice_variables.md new file mode 100644 index 0000000..72f248e --- /dev/null +++ b/tests/results/test/00_9choice_variables.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | +| **source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | +| **my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "source_variable_1".
- the value of the variable "source_variable_2".
**Default**: val1 | + diff --git a/tests/results/test/00_9choice_variables.sh b/tests/results/test/00_9choice_variables.sh new file mode 100644 index 0000000..bd5ca38 --- /dev/null +++ b/tests/results/test/00_9choice_variables.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + source_variable_1 + string standard mandatory The first source variable. + Default: val1 + source_variable_2 + string standard mandatory The second source variable. + Default: val2 + my_variable + choice standard mandatory A variable. + Choices: + + + • the value of the variable "source_variable_1". + • the value of the variable "source_variable_2". Default: val1 + | diff --git a/tests/results/test/00_9default_calculation.adoc b/tests/results/test/00_9default_calculation.adoc new file mode 100644 index 0000000..27b5160 --- /dev/null +++ b/tests/results/test/00_9default_calculation.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: concat all parameters. +|==== + diff --git a/tests/results/test/00_9default_calculation.json b/tests/results/test/00_9default_calculation.json new file mode 100644 index 0000000..4a2b14b --- /dev/null +++ b/tests/results/test/00_9default_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "concat all parameters.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation.md b/tests/results/test/00_9default_calculation.md new file mode 100644 index 0000000..7317bd8 --- /dev/null +++ b/tests/results/test/00_9default_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | + diff --git a/tests/results/test/00_9default_calculation.sh b/tests/results/test/00_9default_calculation.sh new file mode 100644 index 0000000..372f2a2 --- /dev/null +++ b/tests/results/test/00_9default_calculation.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: concat all parameters. + diff --git a/tests/results/test/00_9default_calculation_information.adoc b/tests/results/test/00_9default_calculation_information.adoc new file mode 100644 index 0000000..d96b732 --- /dev/null +++ b/tests/results/test/00_9default_calculation_information.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns the information. +|==== + diff --git a/tests/results/test/00_9default_calculation_information.json b/tests/results/test/00_9default_calculation_information.json new file mode 100644 index 0000000..5f6df7b --- /dev/null +++ b/tests/results/test/00_9default_calculation_information.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "returns the information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_information.md b/tests/results/test/00_9default_calculation_information.md new file mode 100644 index 0000000..2576a4c --- /dev/null +++ b/tests/results/test/00_9default_calculation_information.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | + diff --git a/tests/results/test/00_9default_calculation_information.sh b/tests/results/test/00_9default_calculation_information.sh new file mode 100644 index 0000000..fae5fb2 --- /dev/null +++ b/tests/results/test/00_9default_calculation_information.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A variable. + Default: returns the information. + diff --git a/tests/results/test/00_9default_calculation_information_other_variable.adoc b/tests/results/test/00_9default_calculation_information_other_variable.adoc new file mode 100644 index 0000000..7209a18 --- /dev/null +++ b/tests/results/test/00_9default_calculation_information_other_variable.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/00_9default_calculation_information_other_variable.json b/tests/results/test/00_9default_calculation_information_other_variable.json new file mode 100644 index 0000000..b302a5e --- /dev/null +++ b/tests/results/test/00_9default_calculation_information_other_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_information_other_variable.md b/tests/results/test/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..e8974b1 --- /dev/null +++ b/tests/results/test/00_9default_calculation_information_other_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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**: depends on a calculation. | + diff --git a/tests/results/test/00_9default_calculation_information_other_variable.sh b/tests/results/test/00_9default_calculation_information_other_variable.sh new file mode 100644 index 0000000..a0f93e8 --- /dev/null +++ b/tests/results/test/00_9default_calculation_information_other_variable.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A first variable. + var2 + string standard mandatory A second variable. + Default: depends on a calculation. + diff --git a/tests/results/test/00_9default_calculation_multi_optional.adoc b/tests/results/test/00_9default_calculation_multi_optional.adoc new file mode 100644 index 0000000..d1d59da --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "my_variable". +|==== + diff --git a/tests/results/test/00_9default_calculation_multi_optional.json b/tests/results/test/00_9default_calculation_multi_optional.json new file mode 100644 index 0000000..4d54954 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_multi_optional.md b/tests/results/test/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..1bdb910 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + diff --git a/tests/results/test/00_9default_calculation_multi_optional.sh b/tests/results/test/00_9default_calculation_multi_optional.sh new file mode 100644 index 0000000..80cadf5 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory My_variable. + Default: val1 + my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + Default: the value of the variable + "my_variable". + diff --git a/tests/results/test/00_9default_calculation_multi_optional2.adoc b/tests/results/test/00_9default_calculation_multi_optional2.adoc new file mode 100644 index 0000000..d1d59da --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional2.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +My_variable. + +**Default**: val1 +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "my_variable". +|==== + diff --git a/tests/results/test/00_9default_calculation_multi_optional2.json b/tests/results/test/00_9default_calculation_multi_optional2.json new file mode 100644 index 0000000..4d54954 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional2.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": "val1", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["my_variable"], "names": ["my_variable"]}, "my_calculated_variable": {"type": "variable", "default": ["the value of the variable \"my_variable\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_multi_optional2.md b/tests/results/test/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..1bdb910 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional2.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + diff --git a/tests/results/test/00_9default_calculation_multi_optional2.sh b/tests/results/test/00_9default_calculation_multi_optional2.sh new file mode 100644 index 0000000..80cadf5 --- /dev/null +++ b/tests/results/test/00_9default_calculation_multi_optional2.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory My_variable. + Default: val1 + my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + Default: the value of the variable + "my_variable". + diff --git a/tests/results/test/00_9default_calculation_optional.adoc b/tests/results/test/00_9default_calculation_optional.adoc new file mode 100644 index 0000000..9899394 --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. +|==== + diff --git a/tests/results/test/00_9default_calculation_optional.json b/tests/results/test/00_9default_calculation_optional.json new file mode 100644 index 0000000..54d10bc --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional.json @@ -0,0 +1 @@ +{"my_calculated_variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_optional.md b/tests/results/test/00_9default_calculation_optional.md new file mode 100644 index 0000000..3e059c1 --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable. | + diff --git a/tests/results/test/00_9default_calculation_optional.sh b/tests/results/test/00_9default_calculation_optional.sh new file mode 100644 index 0000000..5aebcad --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional.sh @@ -0,0 +1,12 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + diff --git a/tests/results/test/00_9default_calculation_optional_exists.adoc b/tests/results/test/00_9default_calculation_optional_exists.adoc new file mode 100644 index 0000000..7ec8138 --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional_exists.adoc @@ -0,0 +1,22 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**my_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_variable. + +**Default**: + +* val1 +* val2 +| + +**my_calculated_variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +My_calculated_variable. + +**Default**: the value of the variable "my_variable". +|==== + diff --git a/tests/results/test/00_9default_calculation_optional_exists.json b/tests/results/test/00_9default_calculation_optional_exists.json new file mode 100644 index 0000000..a5c5ab7 --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional_exists.json @@ -0,0 +1 @@ +{"my_variable": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_variable"], "names": ["my_variable"], "multiple": true}, "my_calculated_variable": {"type": "variable", "default": "the value of the variable \"my_variable\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["my_calculated_variable"], "names": ["my_calculated_variable"], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_optional_exists.md b/tests/results/test/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..77e4711 --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional_exists.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + diff --git a/tests/results/test/00_9default_calculation_optional_exists.sh b/tests/results/test/00_9default_calculation_optional_exists.sh new file mode 100644 index 0000000..ddacabe --- /dev/null +++ b/tests/results/test/00_9default_calculation_optional_exists.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + my_variable + string standard mandatory unique My_variable. + multiple + Default: + + + • val1 + • val2 + | | my_calculated_variable string standard mandatory unique multiple + | My_calculated_variable. Default: the value of the variable "my_variable". + | diff --git a/tests/results/test/00_9default_calculation_param_optional.adoc b/tests/results/test/00_9default_calculation_param_optional.adoc new file mode 100644 index 0000000..c597ae9 --- /dev/null +++ b/tests/results/test/00_9default_calculation_param_optional.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. + +**Default**: returns a value. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + diff --git a/tests/results/test/00_9default_calculation_param_optional.json b/tests/results/test/00_9default_calculation_param_optional.json new file mode 100644 index 0000000..13b3321 --- /dev/null +++ b/tests/results/test/00_9default_calculation_param_optional.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "returns a value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_calculation_param_optional.md b/tests/results/test/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..32ea028 --- /dev/null +++ b/tests/results/test/00_9default_calculation_param_optional.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_9default_calculation_param_optional.sh b/tests/results/test/00_9default_calculation_param_optional.sh new file mode 100644 index 0000000..17b3356 --- /dev/null +++ b/tests/results/test/00_9default_calculation_param_optional.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard A first variable. + Default: returns a value. + var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/results/test/00_9default_information_other_variable.adoc b/tests/results/test/00_9default_information_other_variable.adoc new file mode 100644 index 0000000..247e2da --- /dev/null +++ b/tests/results/test/00_9default_information_other_variable.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of the information "test_information" of the variable "var1". +|==== + diff --git a/tests/results/test/00_9default_information_other_variable.json b/tests/results/test/00_9default_information_other_variable.json new file mode 100644 index 0000000..1ccc1e3 --- /dev/null +++ b/tests/results/test/00_9default_information_other_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_information_other_variable.md b/tests/results/test/00_9default_information_other_variable.md new file mode 100644 index 0000000..14d71b3 --- /dev/null +++ b/tests/results/test/00_9default_information_other_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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**: the value of the information "test_information" of the variable "var1". | + diff --git a/tests/results/test/00_9default_information_other_variable.sh b/tests/results/test/00_9default_information_other_variable.sh new file mode 100644 index 0000000..88306b4 --- /dev/null +++ b/tests/results/test/00_9default_information_other_variable.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory A first variable. + var2 + string standard mandatory A second variable. + Default: the value of the information + "test_information" of the variable + "var1". + diff --git a/tests/results/test/00_9default_integer.adoc b/tests/results/test/00_9default_integer.adoc new file mode 100644 index 0000000..f7043ca --- /dev/null +++ b/tests/results/test/00_9default_integer.adoc @@ -0,0 +1,14 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A variable. + +**Choices**: choice for 0 to 9. + +**Default**: 9 +|==== + diff --git a/tests/results/test/00_9default_integer.json b/tests/results/test/00_9default_integer.json new file mode 100644 index 0000000..ec87948 --- /dev/null +++ b/tests/results/test/00_9default_integer.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": 9, "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "choices": "choice for 0 to 9.", "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_9default_integer.md b/tests/results/test/00_9default_integer.md new file mode 100644 index 0000000..883e66c --- /dev/null +++ b/tests/results/test/00_9default_integer.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/00_9default_integer.sh b/tests/results/test/00_9default_integer.sh new file mode 100644 index 0000000..e5b1b82 --- /dev/null +++ b/tests/results/test/00_9default_integer.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A variable. + Choices: choice for 0 to 9. + Default: 9 + diff --git a/tests/results/test/01_6boolean_multi.adoc b/tests/results/test/01_6boolean_multi.adoc new file mode 100644 index 0000000..3809304 --- /dev/null +++ b/tests/results/test/01_6boolean_multi.adoc @@ -0,0 +1,55 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: true +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: true +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: true +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: false +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: false +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: false +| + +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: true +| + +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: true +|==== + diff --git a/tests/results/test/01_6boolean_multi.json b/tests/results/test/01_6boolean_multi.json new file mode 100644 index 0000000..9ed12c7 --- /dev/null +++ b/tests/results/test/01_6boolean_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [false], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [true], "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6boolean_multi.md b/tests/results/test/01_6boolean_multi.md new file mode 100644 index 0000000..d6c7aec --- /dev/null +++ b/tests/results/test/01_6boolean_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/01_6boolean_multi.sh b/tests/results/test/01_6boolean_multi.sh new file mode 100644 index 0000000..621b218 --- /dev/null +++ b/tests/results/test/01_6boolean_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + boolean standard mandatory unique The first variable. + multiple + Default: true + var2 + boolean standard mandatory unique The second variable. + multiple + Default: true + var3 + boolean standard mandatory unique The third variable. + multiple + Default: true + var4 + boolean standard mandatory unique The forth variable. + multiple + Default: false + var5 + boolean standard mandatory unique The fifth variable. + multiple + Default: false + var6 + boolean standard mandatory unique The sixth variable. + multiple + Default: false + var7 + boolean standard mandatory unique The seventh variable. + multiple + Default: true + var8 + boolean standard mandatory unique The eighth variable. + multiple + Default: true + diff --git a/tests/results/test/01_6custom_multi.adoc b/tests/results/test/01_6custom_multi.adoc new file mode 100644 index 0000000..9af5892 --- /dev/null +++ b/tests/results/test/01_6custom_multi.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**custom1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `basic` `mandatory` `unique` `multiple` | +A first custom variable. +| + +**custom2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[custom]` `standard` `mandatory` `unique` `multiple` | +A second custom variable. + +**Default**: value +|==== + diff --git a/tests/results/test/01_6custom_multi.json b/tests/results/test/01_6custom_multi.json new file mode 100644 index 0000000..a197b5a --- /dev/null +++ b/tests/results/test/01_6custom_multi.json @@ -0,0 +1 @@ +{"custom1": {"type": "variable", "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["custom1"], "names": ["custom1"], "descriptions": ["A first custom variable."], "multiple": true}, "custom2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "custom"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["custom2"], "names": ["custom2"], "descriptions": ["A second custom variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6custom_multi.md b/tests/results/test/01_6custom_multi.md new file mode 100644 index 0000000..11d2227 --- /dev/null +++ b/tests/results/test/01_6custom_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/01_6custom_multi.sh b/tests/results/test/01_6custom_multi.sh new file mode 100644 index 0000000..8d32dd7 --- /dev/null +++ b/tests/results/test/01_6custom_multi.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + custom1 + custom basic mandatory unique A first custom variable. + multiple + custom2 + custom standard mandatory unique A second custom variable. + multiple + Default: value + diff --git a/tests/results/test/01_6float_multi.adoc b/tests/results/test/01_6float_multi.adoc new file mode 100644 index 0000000..c3bd243 --- /dev/null +++ b/tests/results/test/01_6float_multi.adoc @@ -0,0 +1,55 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: 0.0 +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: 0.0 +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: 0.0 +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: 10.1 +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: 10.1 +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: 10.1 +| + +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: 0.0 +| + +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[float]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0.0 +|==== + diff --git a/tests/results/test/01_6float_multi.json b/tests/results/test/01_6float_multi.json new file mode 100644 index 0000000..2db8be4 --- /dev/null +++ b/tests/results/test/01_6float_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10.1], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0.0], "properties": [{"type": "type", "name": "float"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6float_multi.md b/tests/results/test/01_6float_multi.md new file mode 100644 index 0000000..00a87a2 --- /dev/null +++ b/tests/results/test/01_6float_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/01_6float_multi.sh b/tests/results/test/01_6float_multi.sh new file mode 100644 index 0000000..fe974af --- /dev/null +++ b/tests/results/test/01_6float_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + float standard mandatory unique The first variable. + multiple + Default: 0.0 + var2 + float standard mandatory unique The second variable. + multiple + Default: 0.0 + var3 + float standard mandatory unique The third variable. + multiple + Default: 0.0 + var4 + float standard mandatory unique The forth variable. + multiple + Default: 10.1 + var5 + float standard mandatory unique The fifth variable. + multiple + Default: 10.1 + var6 + float standard mandatory unique The sixth variable. + multiple + Default: 10.1 + var7 + float standard mandatory unique The seventh variable. + multiple + Default: 0.0 + var8 + float standard mandatory unique The eighth variable. + multiple + Default: 0.0 + diff --git a/tests/results/test/01_6number_multi.adoc b/tests/results/test/01_6number_multi.adoc new file mode 100644 index 0000000..31d28fd --- /dev/null +++ b/tests/results/test/01_6number_multi.adoc @@ -0,0 +1,55 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The first variable. + +**Default**: 0 +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: 0 +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The third variable. + +**Default**: 0 +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: 10 +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: 10 +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: 10 +| + +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: 0 +| + +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: 0 +|==== + diff --git a/tests/results/test/01_6number_multi.json b/tests/results/test/01_6number_multi.json new file mode 100644 index 0000000..ba9ad37 --- /dev/null +++ b/tests/results/test/01_6number_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."], "multiple": true}, "var4": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": [10], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": [0], "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6number_multi.md b/tests/results/test/01_6number_multi.md new file mode 100644 index 0000000..6acde10 --- /dev/null +++ b/tests/results/test/01_6number_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/01_6number_multi.sh b/tests/results/test/01_6number_multi.sh new file mode 100644 index 0000000..1ef58b7 --- /dev/null +++ b/tests/results/test/01_6number_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + number standard mandatory unique The first variable. + multiple + Default: 0 + var2 + number standard mandatory unique The second variable. + multiple + Default: 0 + var3 + number standard mandatory unique The third variable. + multiple + Default: 0 + var4 + number standard mandatory unique The forth variable. + multiple + Default: 10 + var5 + number standard mandatory unique The fifth variable. + multiple + Default: 10 + var6 + number standard mandatory unique The sixth variable. + multiple + Default: 10 + var7 + number standard mandatory unique The seventh variable. + multiple + Default: 0 + var8 + number standard mandatory unique The eighth variable. + multiple + Default: 0 + diff --git a/tests/results/test/01_6string_empty.adoc b/tests/results/test/01_6string_empty.adoc new file mode 100644 index 0000000..5574860 --- /dev/null +++ b/tests/results/test/01_6string_empty.adoc @@ -0,0 +1,16 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The second variable. + +**Default**: + +* value +* null +|==== + diff --git a/tests/results/test/01_6string_empty.json b/tests/results/test/01_6string_empty.json new file mode 100644 index 0000000..423fb94 --- /dev/null +++ b/tests/results/test/01_6string_empty.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["value", null], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6string_empty.md b/tests/results/test/01_6string_empty.md new file mode 100644 index 0000000..5ee3450 --- /dev/null +++ b/tests/results/test/01_6string_empty.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | + diff --git a/tests/results/test/01_6string_empty.sh b/tests/results/test/01_6string_empty.sh new file mode 100644 index 0000000..8352881 --- /dev/null +++ b/tests/results/test/01_6string_empty.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique The second variable. + multiple + Default: + + + • value + • null + | diff --git a/tests/results/test/01_6string_multi.adoc b/tests/results/test/01_6string_multi.adoc new file mode 100644 index 0000000..6d0c1ac --- /dev/null +++ b/tests/results/test/01_6string_multi.adoc @@ -0,0 +1,52 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The first variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The second variable. +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The third variable. +| + +**var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The forth variable. + +**Default**: value +| + +**var5** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The fifth variable. + +**Default**: value +| + +**var6** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The sixth variable. + +**Default**: value +| + +**var7** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The seventh variable. + +**Default**: value +| + +**var8** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +The eighth variable. + +**Default**: value +|==== + diff --git a/tests/results/test/01_6string_multi.json b/tests/results/test/01_6string_multi.json new file mode 100644 index 0000000..135338c --- /dev/null +++ b/tests/results/test/01_6string_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["The first variable."], "multiple": true}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["The second variable."], "multiple": true}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["The third variable."]}, "var4": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var4"], "names": ["var4"], "descriptions": ["The forth variable."], "multiple": true}, "var5": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var5"], "names": ["var5"], "descriptions": ["The fifth variable."], "multiple": true}, "var6": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var6"], "names": ["var6"], "descriptions": ["The sixth variable."], "multiple": true}, "var7": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var7"], "names": ["var7"], "descriptions": ["The seventh variable."], "multiple": true}, "var8": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var8"], "names": ["var8"], "descriptions": ["The eighth variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_6string_multi.md b/tests/results/test/01_6string_multi.md new file mode 100644 index 0000000..ea61013 --- /dev/null +++ b/tests/results/test/01_6string_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/01_6string_multi.sh b/tests/results/test/01_6string_multi.sh new file mode 100644 index 0000000..bb67507 --- /dev/null +++ b/tests/results/test/01_6string_multi.sh @@ -0,0 +1,49 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string basic mandatory unique The first variable. + multiple + var2 + string basic mandatory unique The second variable. + multiple + var3 + string basic mandatory The third variable. + var4 + string standard mandatory unique The forth variable. + multiple + Default: value + var5 + string standard mandatory unique The fifth variable. + multiple + Default: value + var6 + string standard mandatory unique The sixth variable. + multiple + Default: value + var7 + string standard mandatory unique The seventh variable. + multiple + Default: value + var8 + string standard mandatory unique The eighth variable. + multiple + Default: value + diff --git a/tests/results/test/01_7value_multi_doublequote.adoc b/tests/results/test/01_7value_multi_doublequote.adoc new file mode 100644 index 0000000..22318c0 --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote" +|==== + diff --git a/tests/results/test/01_7value_multi_doublequote.json b/tests/results/test/01_7value_multi_doublequote.json new file mode 100644 index 0000000..fa18239 --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_7value_multi_doublequote.md b/tests/results/test/01_7value_multi_doublequote.md new file mode 100644 index 0000000..f1a11a6 --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | + diff --git a/tests/results/test/01_7value_multi_doublequote.sh b/tests/results/test/01_7value_multi_doublequote.sh new file mode 100644 index 0000000..cf15a0c --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: quote" + diff --git a/tests/results/test/01_7value_multi_doublequote2.adoc b/tests/results/test/01_7value_multi_doublequote2.adoc new file mode 100644 index 0000000..4673fc2 --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote2.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote'" +|==== + diff --git a/tests/results/test/01_7value_multi_doublequote2.json b/tests/results/test/01_7value_multi_doublequote2.json new file mode 100644 index 0000000..c067c5f --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote2.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote'\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_7value_multi_doublequote2.md b/tests/results/test/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..cfe2489 --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | + diff --git a/tests/results/test/01_7value_multi_doublequote2.sh b/tests/results/test/01_7value_multi_doublequote2.sh new file mode 100644 index 0000000..8290dae --- /dev/null +++ b/tests/results/test/01_7value_multi_doublequote2.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: quote'" + diff --git a/tests/results/test/01_7value_multi_quote.adoc b/tests/results/test/01_7value_multi_quote.adoc new file mode 100644 index 0000000..a38b695 --- /dev/null +++ b/tests/results/test/01_7value_multi_quote.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: quote' +|==== + diff --git a/tests/results/test/01_7value_multi_quote.json b/tests/results/test/01_7value_multi_quote.json new file mode 100644 index 0000000..5193010 --- /dev/null +++ b/tests/results/test/01_7value_multi_quote.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["quote'"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_7value_multi_quote.md b/tests/results/test/01_7value_multi_quote.md new file mode 100644 index 0000000..4186e41 --- /dev/null +++ b/tests/results/test/01_7value_multi_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | + diff --git a/tests/results/test/01_7value_multi_quote.sh b/tests/results/test/01_7value_multi_quote.sh new file mode 100644 index 0000000..0d231bf --- /dev/null +++ b/tests/results/test/01_7value_multi_quote.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: quote' + diff --git a/tests/results/test/01_8calculation_information_multi.adoc b/tests/results/test/01_8calculation_information_multi.adoc new file mode 100644 index 0000000..a2fcbe8 --- /dev/null +++ b/tests/results/test/01_8calculation_information_multi.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: get information test_information. +|==== + diff --git a/tests/results/test/01_8calculation_information_multi.json b/tests/results/test/01_8calculation_information_multi.json new file mode 100644 index 0000000..fbbadb7 --- /dev/null +++ b/tests/results/test/01_8calculation_information_multi.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "get information test_information.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/01_8calculation_information_multi.md b/tests/results/test/01_8calculation_information_multi.md new file mode 100644 index 0000000..cb01009 --- /dev/null +++ b/tests/results/test/01_8calculation_information_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/01_8calculation_information_multi.sh b/tests/results/test/01_8calculation_information_multi.sh new file mode 100644 index 0000000..12ee764 --- /dev/null +++ b/tests/results/test/01_8calculation_information_multi.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: get information + test_information. + diff --git a/tests/results/test/01_9choice_variable_multi.adoc b/tests/results/test/01_9choice_variable_multi.adoc new file mode 100644 index 0000000..5c927eb --- /dev/null +++ b/tests/results/test/01_9choice_variable_multi.adoc @@ -0,0 +1,23 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* a +* b +* c +| + +**variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A second variable. + +**Choices**: the value of the variable "variable1". +|==== + diff --git a/tests/results/test/01_9choice_variable_multi.json b/tests/results/test/01_9choice_variable_multi.json new file mode 100644 index 0000000..aaa0991 --- /dev/null +++ b/tests/results/test/01_9choice_variable_multi.json @@ -0,0 +1 @@ +{"variable1": {"type": "variable", "default": ["a", "b", "c"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": "the value of the variable \"variable1\".", "paths": ["variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/01_9choice_variable_multi.md b/tests/results/test/01_9choice_variable_multi.md new file mode 100644 index 0000000..c9b0de1 --- /dev/null +++ b/tests/results/test/01_9choice_variable_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/01_9choice_variable_multi.sh b/tests/results/test/01_9choice_variable_multi.sh new file mode 100644 index 0000000..a893ba8 --- /dev/null +++ b/tests/results/test/01_9choice_variable_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable1 + string standard mandatory unique A first variable. + multiple + Default: + + + • a + • b + • c + | | variable2 choice basic mandatory + | A second variable. Choices: the value of the variable "variable1". + | diff --git a/tests/results/test/04_0type_param.adoc b/tests/results/test/04_0type_param.adoc new file mode 100644 index 0000000..d8534f8 --- /dev/null +++ b/tests/results/test/04_0type_param.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A limited number. + +**Validators**: + +* the minimum value is 0 +* the maximum value is 100 + +**Default**: 10 +|==== + diff --git a/tests/results/test/04_0type_param.json b/tests/results/test/04_0type_param.json new file mode 100644 index 0000000..d236ebc --- /dev/null +++ b/tests/results/test/04_0type_param.json @@ -0,0 +1 @@ +{"int": {"type": "variable", "default": 10, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["the minimum value is 0", "the maximum value is 100"], "paths": ["int"], "names": ["int"], "descriptions": ["A limited number."]}} \ No newline at end of file diff --git a/tests/results/test/04_0type_param.md b/tests/results/test/04_0type_param.md new file mode 100644 index 0000000..788b37d --- /dev/null +++ b/tests/results/test/04_0type_param.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | + diff --git a/tests/results/test/04_0type_param.sh b/tests/results/test/04_0type_param.sh new file mode 100644 index 0000000..e84cdd4 --- /dev/null +++ b/tests/results/test/04_0type_param.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + int + number standard mandatory A limited number. + Validators: + + + • the minimum value is 0 + • the maximum value is 100 Default: 10 + | diff --git a/tests/results/test/04_1auto_save.adoc b/tests/results/test/04_1auto_save.adoc new file mode 100644 index 0000000..fb580ec --- /dev/null +++ b/tests/results/test/04_1auto_save.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +An auto save variable. + +**Default**: no +|==== + diff --git a/tests/results/test/04_1auto_save.json b/tests/results/test/04_1auto_save.json new file mode 100644 index 0000000..1b315d0 --- /dev/null +++ b/tests/results/test/04_1auto_save.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["An auto save variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_1auto_save.md b/tests/results/test/04_1auto_save.md new file mode 100644 index 0000000..950c21d --- /dev/null +++ b/tests/results/test/04_1auto_save.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/04_1auto_save.sh b/tests/results/test/04_1auto_save.sh new file mode 100644 index 0000000..c88b21b --- /dev/null +++ b/tests/results/test/04_1auto_save.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory auto modified An auto save variable. + Default: no + diff --git a/tests/results/test/04_1auto_save_and_calculated.adoc b/tests/results/test/04_1auto_save_and_calculated.adoc new file mode 100644 index 0000000..5995d15 --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `auto modified` | +A second variable. + +**Default**: the value of the variable "var1". +|==== + diff --git a/tests/results/test/04_1auto_save_and_calculated.json b/tests/results/test/04_1auto_save_and_calculated.json new file mode 100644 index 0000000..56d891b --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the variable \"var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_1auto_save_and_calculated.md b/tests/results/test/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..7d1cd38 --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_1auto_save_and_calculated.sh b/tests/results/test/04_1auto_save_and_calculated.sh new file mode 100644 index 0000000..e3b7153 --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string basic mandatory auto modified A second variable. + Default: the value of the variable + "var1". + diff --git a/tests/results/test/04_1auto_save_and_calculated_hidden.adoc b/tests/results/test/04_1auto_save_and_calculated_hidden.adoc new file mode 100644 index 0000000..2963d97 --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated_hidden.adoc @@ -0,0 +1,20 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__hidden__` `auto modified` | +A second variable. + +**Default**: the value is always yes. + +**Hidden**: only if the variable var1 has value "yes". +|==== + diff --git a/tests/results/test/04_1auto_save_and_calculated_hidden.json b/tests/results/test/04_1auto_save_and_calculated_hidden.json new file mode 100644 index 0000000..6768c6f --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated_hidden.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value is always yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "hidden", "annotation": "only if the variable var1 has value \"yes\"."}, {"type": "property", "name": "auto modified"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_1auto_save_and_calculated_hidden.md b/tests/results/test/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..db4d2e2 --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_1auto_save_and_calculated_hidden.sh b/tests/results/test/04_1auto_save_and_calculated_hidden.sh new file mode 100644 index 0000000..7c5f16a --- /dev/null +++ b/tests/results/test/04_1auto_save_and_calculated_hidden.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string basic mandatory hidden auto  A second variable. + modified + Default: the value is always yes. + Hidden: only if the variable var1 + has value "yes". + diff --git a/tests/results/test/04_1auto_save_and_hidden.adoc b/tests/results/test/04_1auto_save_and_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/04_1auto_save_and_hidden.json b/tests/results/test/04_1auto_save_and_hidden.json similarity index 100% rename from tests/docs/base/04_1auto_save_and_hidden.json rename to tests/results/test/04_1auto_save_and_hidden.json diff --git a/tests/results/test/04_1auto_save_and_hidden.md b/tests/results/test/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/04_1auto_save_and_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/04_1auto_save_and_hidden.sh b/tests/results/test/04_1auto_save_and_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/04_1default_calculation_hidden.adoc b/tests/results/test/04_1default_calculation_hidden.adoc new file mode 100644 index 0000000..7d345df --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden.adoc @@ -0,0 +1,25 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: value +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A second variable. + +**Disabled**: when the variable "var1" has the value "value". +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/04_1default_calculation_hidden.json b/tests/results/test/04_1default_calculation_hidden.json new file mode 100644 index 0000000..5611a20 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"var1\" has the value \"value\"."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_1default_calculation_hidden.md b/tests/results/test/04_1default_calculation_hidden.md new file mode 100644 index 0000000..86e8813 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/04_1default_calculation_hidden.sh b/tests/results/test/04_1default_calculation_hidden.sh new file mode 100644 index 0000000..cead897 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: value + var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "var1" + has the value "value". + var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/results/test/04_1default_calculation_hidden_2.adoc b/tests/results/test/04_1default_calculation_hidden_2.adoc new file mode 100644 index 0000000..7d345df --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden_2.adoc @@ -0,0 +1,25 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: value +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A second variable. + +**Disabled**: when the variable "var1" has the value "value". +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/04_1default_calculation_hidden_2.json b/tests/results/test/04_1default_calculation_hidden_2.json new file mode 100644 index 0000000..5611a20 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden_2.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"var1\" has the value \"value\"."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_1default_calculation_hidden_2.md b/tests/results/test/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..86e8813 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden_2.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/04_1default_calculation_hidden_2.sh b/tests/results/test/04_1default_calculation_hidden_2.sh new file mode 100644 index 0000000..cead897 --- /dev/null +++ b/tests/results/test/04_1default_calculation_hidden_2.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: value + var2 + string basic mandatory disabled A second variable. + Disabled: when the variable "var1" + has the value "value". + var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/results/test/04_5disabled_calculation_optional.adoc b/tests/results/test/04_5disabled_calculation_optional.adoc new file mode 100644 index 0000000..d1e90bf --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_optional.adoc @@ -0,0 +1,25 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | +A first variable. + +**Hidden**: calculation from an unknown variable. +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | +A second variable. + +**Hidden**: calculation from an condition variable. +|==== + diff --git a/tests/results/test/04_5disabled_calculation_optional.json b/tests/results/test/04_5disabled_calculation_optional.json new file mode 100644 index 0000000..fac97da --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_optional.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an unknown variable."}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "calculation from an condition variable."}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_optional.md b/tests/results/test/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..a8178c3 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_optional.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# 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) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | + diff --git a/tests/results/test/04_5disabled_calculation_optional.sh b/tests/results/test/04_5disabled_calculation_optional.sh new file mode 100644 index 0000000..d8e8153 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_optional.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + var1 + string standard hidden A first variable. + Hidden: calculation from an unknown + variable. + var2 + string standard hidden A second variable. + Hidden: calculation from an + condition variable. + diff --git a/tests/results/test/04_5disabled_calculation_variable.adoc b/tests/results/test/04_5disabled_calculation_variable.adoc new file mode 100644 index 0000000..c6dadaf --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: false +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A variable. + +**Disabled**: when the variable "condition" has the value "true". +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable.json b/tests/results/test/04_5disabled_calculation_variable.json new file mode 100644 index 0000000..d714c16 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_variable.md b/tests/results/test/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..08a4458 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_5disabled_calculation_variable.sh b/tests/results/test/04_5disabled_calculation_variable.sh new file mode 100644 index 0000000..a1c9dd2 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: false + variable + string basic mandatory disabled A variable. + Disabled: when the variable + "condition" has the value "true". + diff --git a/tests/results/test/04_5disabled_calculation_variable2.adoc b/tests/results/test/04_5disabled_calculation_variable2.adoc new file mode 100644 index 0000000..44ee0cd --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable2.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: true +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A variable. + +**Disabled**: when the variable "condition" has the value "true". +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable2.json b/tests/results/test/04_5disabled_calculation_variable2.json new file mode 100644 index 0000000..a1e5851 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable2.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_variable2.md b/tests/results/test/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..236b39d --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable2.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_5disabled_calculation_variable2.sh b/tests/results/test/04_5disabled_calculation_variable2.sh new file mode 100644 index 0000000..d38bd08 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable2.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: true + variable + string basic mandatory disabled A variable. + Disabled: when the variable + "condition" has the value "true". + diff --git a/tests/results/test/04_5disabled_calculation_variable3.adoc b/tests/results/test/04_5disabled_calculation_variable3.adoc new file mode 100644 index 0000000..b5b15c0 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable3.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A variable. + +**Disabled**: when the variable "condition" has the value "yes". +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable3.json b/tests/results/test/04_5disabled_calculation_variable3.json new file mode 100644 index 0000000..1e0ed0a --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable3.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" has the value \"yes\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_variable3.md b/tests/results/test/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..b234190 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable3.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_5disabled_calculation_variable3.sh b/tests/results/test/04_5disabled_calculation_variable3.sh new file mode 100644 index 0000000..405ce04 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable3.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + variable + string basic mandatory disabled A variable. + Disabled: when the variable + "condition" has the value "yes". + diff --git a/tests/results/test/04_5disabled_calculation_variable4.adoc b/tests/results/test/04_5disabled_calculation_variable4.adoc new file mode 100644 index 0000000..379504f --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable4.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A variable. + +**Disabled**: when the variable "condition" hasn't the value "yes". +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable4.json b/tests/results/test/04_5disabled_calculation_variable4.json new file mode 100644 index 0000000..1b13ad3 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable4.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "when the variable \"condition\" hasn't the value \"yes\"."}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5disabled_calculation_variable4.md b/tests/results/test/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..a33bee0 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable4.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/04_5disabled_calculation_variable4.sh b/tests/results/test/04_5disabled_calculation_variable4.sh new file mode 100644 index 0000000..1993b84 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable4.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + variable + string basic mandatory disabled A variable. + Disabled: when the variable + "condition" hasn't the value "yes". + diff --git a/tests/results/test/04_5validators.adoc b/tests/results/test/04_5validators.adoc new file mode 100644 index 0000000..6ad5405 --- /dev/null +++ b/tests/results/test/04_5validators.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A number. + +**Validator**: the max value is 100. +|==== + diff --git a/tests/results/test/04_5validators.json b/tests/results/test/04_5validators.json new file mode 100644 index 0000000..d1fb25b --- /dev/null +++ b/tests/results/test/04_5validators.json @@ -0,0 +1 @@ +{"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["the max value is 100."], "paths": ["int"], "names": ["int"], "descriptions": ["A number."]}} \ No newline at end of file diff --git a/tests/results/test/04_5validators.md b/tests/results/test/04_5validators.md new file mode 100644 index 0000000..247fd71 --- /dev/null +++ b/tests/results/test/04_5validators.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/04_5validators.sh b/tests/results/test/04_5validators.sh new file mode 100644 index 0000000..1cf76c5 --- /dev/null +++ b/tests/results/test/04_5validators.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + int + number basic mandatory A number. + Validator: the max value is 100. + diff --git a/tests/results/test/04_5validators_differ.adoc b/tests/results/test/04_5validators_differ.adoc new file mode 100644 index 0000000..d3ca56c --- /dev/null +++ b/tests/results/test/04_5validators_differ.adoc @@ -0,0 +1,21 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Validator**: var1 must be different than var2. + +**Default**: oui + +**Example**: another_value +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + diff --git a/tests/results/test/04_5validators_differ.json b/tests/results/test/04_5validators_differ.json new file mode 100644 index 0000000..0c7761e --- /dev/null +++ b/tests/results/test/04_5validators_differ.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "oui", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var1 must be different than var2."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["another_value"]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/04_5validators_differ.md b/tests/results/test/04_5validators_differ.md new file mode 100644 index 0000000..9bd0c63 --- /dev/null +++ b/tests/results/test/04_5validators_differ.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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
**Example**: another_value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + diff --git a/tests/results/test/04_5validators_differ.sh b/tests/results/test/04_5validators_differ.sh new file mode 100644 index 0000000..add43aa --- /dev/null +++ b/tests/results/test/04_5validators_differ.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Validator: var1 must be different + than var2. + Default: oui + Example: another_value + var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/results/test/04_5validators_multi.adoc b/tests/results/test/04_5validators_multi.adoc new file mode 100644 index 0000000..35bf90d --- /dev/null +++ b/tests/results/test/04_5validators_multi.adoc @@ -0,0 +1,17 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 10. + +**Default**: + +* no +* yes +|==== + diff --git a/tests/results/test/04_5validators_multi.json b/tests/results/test/04_5validators_multi.json new file mode 100644 index 0000000..90b292d --- /dev/null +++ b/tests/results/test/04_5validators_multi.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 10."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/04_5validators_multi.md b/tests/results/test/04_5validators_multi.md new file mode 100644 index 0000000..7957908 --- /dev/null +++ b/tests/results/test/04_5validators_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | + diff --git a/tests/results/test/04_5validators_multi.sh b/tests/results/test/04_5validators_multi.sh new file mode 100644 index 0000000..76fa35c --- /dev/null +++ b/tests/results/test/04_5validators_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A second variable. + multiple + Validator: check length is less than + 10. + Default: + + + • no + • yes + | diff --git a/tests/results/test/04_5validators_multi2.adoc b/tests/results/test/04_5validators_multi2.adoc new file mode 100644 index 0000000..f1e5ef5 --- /dev/null +++ b/tests/results/test/04_5validators_multi2.adoc @@ -0,0 +1,22 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 3. + +**Default**: + +* no +* yes + +**Examples**: + +* val1 +* val2 +|==== + diff --git a/tests/results/test/04_5validators_multi2.json b/tests/results/test/04_5validators_multi2.json new file mode 100644 index 0000000..4f5f119 --- /dev/null +++ b/tests/results/test/04_5validators_multi2.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["no", "yes"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "validators": ["check length is less than 3."], "paths": ["var1"], "names": ["var1"], "descriptions": ["A second variable."], "multiple": true, "examples": ["val1", "val2"]}} \ No newline at end of file diff --git a/tests/results/test/04_5validators_multi2.md b/tests/results/test/04_5validators_multi2.md new file mode 100644 index 0000000..90a7746 --- /dev/null +++ b/tests/results/test/04_5validators_multi2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | + diff --git a/tests/results/test/04_5validators_multi2.sh b/tests/results/test/04_5validators_multi2.sh new file mode 100644 index 0000000..fed9cf5 --- /dev/null +++ b/tests/results/test/04_5validators_multi2.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A second variable. + multiple + Validator: check length is less than + 3. + Default: + + + • no + • yes Examples: + • val1 + • val2 + | diff --git a/tests/results/test/05_0multi_not_uniq.adoc b/tests/results/test/05_0multi_not_uniq.adoc new file mode 100644 index 0000000..0d76fad --- /dev/null +++ b/tests/results/test/05_0multi_not_uniq.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A variable. + +**Default**: non +|==== + diff --git a/tests/results/test/05_0multi_not_uniq.json b/tests/results/test/05_0multi_not_uniq.json new file mode 100644 index 0000000..723c516 --- /dev/null +++ b/tests/results/test/05_0multi_not_uniq.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/05_0multi_not_uniq.md b/tests/results/test/05_0multi_not_uniq.md new file mode 100644 index 0000000..96e70cd --- /dev/null +++ b/tests/results/test/05_0multi_not_uniq.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test/05_0multi_not_uniq.sh b/tests/results/test/05_0multi_not_uniq.sh new file mode 100644 index 0000000..da376f9 --- /dev/null +++ b/tests/results/test/05_0multi_not_uniq.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory multiple A variable. + Default: non + diff --git a/tests/results/test/05_0multi_uniq.adoc b/tests/results/test/05_0multi_uniq.adoc new file mode 100644 index 0000000..1724b8f --- /dev/null +++ b/tests/results/test/05_0multi_uniq.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non +|==== + diff --git a/tests/results/test/05_0multi_uniq.json b/tests/results/test/05_0multi_uniq.json new file mode 100644 index 0000000..e2af7df --- /dev/null +++ b/tests/results/test/05_0multi_uniq.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/05_0multi_uniq.md b/tests/results/test/05_0multi_uniq.md new file mode 100644 index 0000000..ed2f51e --- /dev/null +++ b/tests/results/test/05_0multi_uniq.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test/05_0multi_uniq.sh b/tests/results/test/05_0multi_uniq.sh new file mode 100644 index 0000000..0ef25ef --- /dev/null +++ b/tests/results/test/05_0multi_uniq.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: non + diff --git a/tests/results/test/12_1auto_save_expert.adoc b/tests/results/test/12_1auto_save_expert.adoc new file mode 100644 index 0000000..3dfeae6 --- /dev/null +++ b/tests/results/test/12_1auto_save_expert.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` `mandatory` `auto modified` | +A variable. + +**Default**: no +|==== + diff --git a/tests/results/test/12_1auto_save_expert.json b/tests/results/test/12_1auto_save_expert.json new file mode 100644 index 0000000..fe9baf5 --- /dev/null +++ b/tests/results/test/12_1auto_save_expert.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "advanced"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "auto modified"}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/12_1auto_save_expert.md b/tests/results/test/12_1auto_save_expert.md new file mode 100644 index 0000000..8890d6f --- /dev/null +++ b/tests/results/test/12_1auto_save_expert.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` `auto modified` | A variable.
**Default**: no | + diff --git a/tests/results/test/12_1auto_save_expert.sh b/tests/results/test/12_1auto_save_expert.sh new file mode 100644 index 0000000..6d679cc --- /dev/null +++ b/tests/results/test/12_1auto_save_expert.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string advanced mandatory auto  A variable. + modified + Default: no + diff --git a/tests/results/test/16_0redefine_description.adoc b/tests/results/test/16_0redefine_description.adoc new file mode 100644 index 0000000..fa322c0 --- /dev/null +++ b/tests/results/test/16_0redefine_description.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefined. +|==== + diff --git a/tests/results/test/16_0redefine_description.json b/tests/results/test/16_0redefine_description.json new file mode 100644 index 0000000..4eaffe7 --- /dev/null +++ b/tests/results/test/16_0redefine_description.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["Redefined."]}} \ No newline at end of file diff --git a/tests/results/test/16_0redefine_description.md b/tests/results/test/16_0redefine_description.md new file mode 100644 index 0000000..f05b383 --- /dev/null +++ b/tests/results/test/16_0redefine_description.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | + diff --git a/tests/results/test/16_0redefine_description.sh b/tests/results/test/16_0redefine_description.sh new file mode 100644 index 0000000..0b06a1c --- /dev/null +++ b/tests/results/test/16_0redefine_description.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory Redefined. + diff --git a/tests/results/test/16_2family_redefine_calculation.adoc b/tests/results/test/16_2family_redefine_calculation.adoc new file mode 100644 index 0000000..5cb2dfe --- /dev/null +++ b/tests/results/test/16_2family_redefine_calculation.adoc @@ -0,0 +1,19 @@ +== Variables + +=== family + +`basic` `__disabled__` + + +**Disabled**: depends on a calculation. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var1. +|==== + diff --git a/tests/results/test/16_2family_redefine_calculation.json b/tests/results/test/16_2family_redefine_calculation.json new file mode 100644 index 0000000..81d3505 --- /dev/null +++ b/tests/results/test/16_2family_redefine_calculation.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "disabled", "annotation": "depends on a calculation."}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"]}}}} \ No newline at end of file diff --git a/tests/results/test/16_2family_redefine_calculation.md b/tests/results/test/16_2family_redefine_calculation.md new file mode 100644 index 0000000..00bf36a --- /dev/null +++ b/tests/results/test/16_2family_redefine_calculation.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## family + +`basic` *`disabled`* + +**Disabled**: depends on a calculation. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | + diff --git a/tests/results/test/16_2family_redefine_calculation.sh b/tests/results/test/16_2family_redefine_calculation.sh new file mode 100644 index 0000000..13b8eac --- /dev/null +++ b/tests/results/test/16_2family_redefine_calculation.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + family + +basic disabled + +Disabled: depends on a calculation. + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory Var1. + diff --git a/tests/results/test/16_2family_redefine_disabled.adoc b/tests/results/test/16_2family_redefine_disabled.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/16_2family_redefine_disabled.json b/tests/results/test/16_2family_redefine_disabled.json similarity index 100% rename from tests/docs/base/16_2family_redefine_disabled.json rename to tests/results/test/16_2family_redefine_disabled.json diff --git a/tests/results/test/16_2family_redefine_disabled.md b/tests/results/test/16_2family_redefine_disabled.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/16_2family_redefine_disabled.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/16_2family_redefine_disabled.sh b/tests/results/test/16_2family_redefine_disabled.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/16_5exists_nonexists.adoc b/tests/results/test/16_5exists_nonexists.adoc new file mode 100644 index 0000000..2fe9863 --- /dev/null +++ b/tests/results/test/16_5exists_nonexists.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A new variable. + +**Default**: yes +|==== + diff --git a/tests/results/test/16_5exists_nonexists.json b/tests/results/test/16_5exists_nonexists.json new file mode 100644 index 0000000..0cfdfd1 --- /dev/null +++ b/tests/results/test/16_5exists_nonexists.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A variable."]}, "var2": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A new variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5exists_nonexists.md b/tests/results/test/16_5exists_nonexists.md new file mode 100644 index 0000000..a8235c8 --- /dev/null +++ b/tests/results/test/16_5exists_nonexists.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/16_5exists_nonexists.sh b/tests/results/test/16_5exists_nonexists.sh new file mode 100644 index 0000000..a19b6a9 --- /dev/null +++ b/tests/results/test/16_5exists_nonexists.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A variable. + Default: no + var2 + string standard mandatory A new variable. + Default: yes + diff --git a/tests/results/test/16_5exists_redefine.adoc b/tests/results/test/16_5exists_redefine.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/16_5exists_redefine.json b/tests/results/test/16_5exists_redefine.json similarity index 100% rename from tests/docs/base/16_5exists_redefine.json rename to tests/results/test/16_5exists_redefine.json diff --git a/tests/results/test/16_5exists_redefine.md b/tests/results/test/16_5exists_redefine.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/16_5exists_redefine.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/16_5exists_redefine.sh b/tests/results/test/16_5exists_redefine.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/16_5redefine_calculation.adoc b/tests/results/test/16_5redefine_calculation.adoc new file mode 100644 index 0000000..0ebb242 --- /dev/null +++ b/tests/results/test/16_5redefine_calculation.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns yes. +|==== + diff --git a/tests/results/test/16_5redefine_calculation.json b/tests/results/test/16_5redefine_calculation.json new file mode 100644 index 0000000..4852bcd --- /dev/null +++ b/tests/results/test/16_5redefine_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "returns yes.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_calculation.md b/tests/results/test/16_5redefine_calculation.md new file mode 100644 index 0000000..247f062 --- /dev/null +++ b/tests/results/test/16_5redefine_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + diff --git a/tests/results/test/16_5redefine_calculation.sh b/tests/results/test/16_5redefine_calculation.sh new file mode 100644 index 0000000..945184c --- /dev/null +++ b/tests/results/test/16_5redefine_calculation.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: returns yes. + diff --git a/tests/results/test/16_5redefine_choice.adoc b/tests/results/test/16_5redefine_choice.adoc new file mode 100644 index 0000000..da4e447 --- /dev/null +++ b/tests/results/test/16_5redefine_choice.adoc @@ -0,0 +1,16 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `basic` `mandatory` | +A variable. + +**Choices**: + +* a +* b +|==== + diff --git a/tests/results/test/16_5redefine_choice.json b/tests/results/test/16_5redefine_choice.json new file mode 100644 index 0000000..3309f59 --- /dev/null +++ b/tests/results/test/16_5redefine_choice.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b"], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_choice.md b/tests/results/test/16_5redefine_choice.md new file mode 100644 index 0000000..f778a93 --- /dev/null +++ b/tests/results/test/16_5redefine_choice.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | + diff --git a/tests/results/test/16_5redefine_choice.sh b/tests/results/test/16_5redefine_choice.sh new file mode 100644 index 0000000..b539e74 --- /dev/null +++ b/tests/results/test/16_5redefine_choice.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + choice basic mandatory A variable. + Choices: + + + • a + • b + | diff --git a/tests/results/test/16_5redefine_default.adoc b/tests/results/test/16_5redefine_default.adoc new file mode 100644 index 0000000..6c8b15a --- /dev/null +++ b/tests/results/test/16_5redefine_default.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: yes +|==== + diff --git a/tests/results/test/16_5redefine_default.json b/tests/results/test/16_5redefine_default.json new file mode 100644 index 0000000..4527689 --- /dev/null +++ b/tests/results/test/16_5redefine_default.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_default.md b/tests/results/test/16_5redefine_default.md new file mode 100644 index 0000000..2f0f6c4 --- /dev/null +++ b/tests/results/test/16_5redefine_default.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | + diff --git a/tests/results/test/16_5redefine_default.sh b/tests/results/test/16_5redefine_default.sh new file mode 100644 index 0000000..730a7b1 --- /dev/null +++ b/tests/results/test/16_5redefine_default.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory A variable. + Default: yes + diff --git a/tests/results/test/16_5redefine_default_calculation.adoc b/tests/results/test/16_5redefine_default_calculation.adoc new file mode 100644 index 0000000..081164f --- /dev/null +++ b/tests/results/test/16_5redefine_default_calculation.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/16_5redefine_default_calculation.json b/tests/results/test/16_5redefine_default_calculation.json new file mode 100644 index 0000000..85ca66e --- /dev/null +++ b/tests/results/test/16_5redefine_default_calculation.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_default_calculation.md b/tests/results/test/16_5redefine_default_calculation.md new file mode 100644 index 0000000..544e968 --- /dev/null +++ b/tests/results/test/16_5redefine_default_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/16_5redefine_default_calculation.sh b/tests/results/test/16_5redefine_default_calculation.sh new file mode 100644 index 0000000..68e3769 --- /dev/null +++ b/tests/results/test/16_5redefine_default_calculation.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory A variable. + diff --git a/tests/results/test/16_5redefine_family.adoc b/tests/results/test/16_5redefine_family.adoc new file mode 100644 index 0000000..05cf105 --- /dev/null +++ b/tests/results/test/16_5redefine_family.adoc @@ -0,0 +1,16 @@ +== Variables + +=== new description + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/16_5redefine_family.json b/tests/results/test/16_5redefine_family.json new file mode 100644 index 0000000..48f6cbf --- /dev/null +++ b/tests/results/test/16_5redefine_family.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "new description", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_family.md b/tests/results/test/16_5redefine_family.md new file mode 100644 index 0000000..6bc7df0 --- /dev/null +++ b/tests/results/test/16_5redefine_family.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/16_5redefine_family.sh b/tests/results/test/16_5redefine_family.sh new file mode 100644 index 0000000..5ebfe57 --- /dev/null +++ b/tests/results/test/16_5redefine_family.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable + string basic mandatory A variable. + diff --git a/tests/results/test/16_5redefine_help.adoc b/tests/results/test/16_5redefine_help.adoc new file mode 100644 index 0000000..eb646f2 --- /dev/null +++ b/tests/results/test/16_5redefine_help.adoc @@ -0,0 +1,19 @@ +== Variables + +=== a family + +`basic` + +Redefine help family ok. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefine help. + +Redefine help ok. +|==== + diff --git a/tests/results/test/16_5redefine_help.json b/tests/results/test/16_5redefine_help.json new file mode 100644 index 0000000..831ee7f --- /dev/null +++ b/tests/results/test/16_5redefine_help.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "help": ["Redefine help family ok."], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable"], "names": ["variable"], "help": ["Redefine help ok."], "descriptions": ["Redefine help."]}}}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_help.md b/tests/results/test/16_5redefine_help.md new file mode 100644 index 0000000..ee73bc0 --- /dev/null +++ b/tests/results/test/16_5redefine_help.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +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. | + diff --git a/tests/results/test/16_5redefine_help.sh b/tests/results/test/16_5redefine_help.sh new file mode 100644 index 0000000..e38fe9b --- /dev/null +++ b/tests/results/test/16_5redefine_help.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + +Redefine help family ok. + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable + string basic mandatory Redefine help. + Redefine help ok. + diff --git a/tests/results/test/16_5redefine_hidden.adoc b/tests/results/test/16_5redefine_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/16_5redefine_hidden.json b/tests/results/test/16_5redefine_hidden.json similarity index 100% rename from tests/docs/base/16_5redefine_hidden.json rename to tests/results/test/16_5redefine_hidden.json diff --git a/tests/results/test/16_5redefine_hidden.md b/tests/results/test/16_5redefine_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/16_5redefine_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/16_5redefine_hidden.sh b/tests/results/test/16_5redefine_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/16_5redefine_multi.adoc b/tests/results/test/16_5redefine_multi.adoc new file mode 100644 index 0000000..1724b8f --- /dev/null +++ b/tests/results/test/16_5redefine_multi.adoc @@ -0,0 +1,13 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non +|==== + diff --git a/tests/results/test/16_5redefine_multi.json b/tests/results/test/16_5redefine_multi.json new file mode 100644 index 0000000..e2af7df --- /dev/null +++ b/tests/results/test/16_5redefine_multi.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "default": ["non"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_multi.md b/tests/results/test/16_5redefine_multi.md new file mode 100644 index 0000000..ed2f51e --- /dev/null +++ b/tests/results/test/16_5redefine_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test/16_5redefine_multi.sh b/tests/results/test/16_5redefine_multi.sh new file mode 100644 index 0000000..0ef25ef --- /dev/null +++ b/tests/results/test/16_5redefine_multi.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string standard mandatory unique A variable. + multiple + Default: non + diff --git a/tests/results/test/16_5redefine_remove_disable_calculation.adoc b/tests/results/test/16_5redefine_remove_disable_calculation.adoc new file mode 100644 index 0000000..08a6b89 --- /dev/null +++ b/tests/results/test/16_5redefine_remove_disable_calculation.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/16_5redefine_remove_disable_calculation.json b/tests/results/test/16_5redefine_remove_disable_calculation.json new file mode 100644 index 0000000..fb65618 --- /dev/null +++ b/tests/results/test/16_5redefine_remove_disable_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5redefine_remove_disable_calculation.md b/tests/results/test/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..3ee1a36 --- /dev/null +++ b/tests/results/test/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/16_5redefine_remove_disable_calculation.sh b/tests/results/test/16_5redefine_remove_disable_calculation.sh new file mode 100644 index 0000000..31aaba8 --- /dev/null +++ b/tests/results/test/16_5redefine_remove_disable_calculation.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + variable + string basic mandatory A variable. + diff --git a/tests/results/test/16_5test_redefine.adoc b/tests/results/test/16_5test_redefine.adoc new file mode 100644 index 0000000..c34b696 --- /dev/null +++ b/tests/results/test/16_5test_redefine.adoc @@ -0,0 +1,26 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no + +**Example**: test1 +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: non + +**Example**: test1 +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A third variable. +|==== + diff --git a/tests/results/test/16_5test_redefine.json b/tests/results/test/16_5test_redefine.json new file mode 100644 index 0000000..c6596d1 --- /dev/null +++ b/tests/results/test/16_5test_redefine.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."], "examples": ["test1"]}, "var2": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."], "examples": ["test1"]}, "var3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/results/test/16_5test_redefine.md b/tests/results/test/16_5test_redefine.md new file mode 100644 index 0000000..0a53159 --- /dev/null +++ b/tests/results/test/16_5test_redefine.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/16_5test_redefine.sh b/tests/results/test/16_5test_redefine.sh new file mode 100644 index 0000000..4200334 --- /dev/null +++ b/tests/results/test/16_5test_redefine.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + Example: test1 + var2 + string standard mandatory A second variable. + Default: non + Example: test1 + var3 + string basic mandatory A third variable. + diff --git a/tests/results/test/16_6choice_redefine.adoc b/tests/results/test/16_6choice_redefine.adoc new file mode 100644 index 0000000..5dc70b4 --- /dev/null +++ b/tests/results/test/16_6choice_redefine.adoc @@ -0,0 +1,16 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `standard` `mandatory` | +A choice. + +**Choices**: + +* a +* c ← (default) +|==== + diff --git a/tests/results/test/16_6choice_redefine.json b/tests/results/test/16_6choice_redefine.json new file mode 100644 index 0000000..7329e05 --- /dev/null +++ b/tests/results/test/16_6choice_redefine.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "c", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "display_default": false, "choices": ["a", "c ← (default)"], "paths": ["var"], "names": ["var"], "descriptions": ["A choice."]}} \ No newline at end of file diff --git a/tests/results/test/16_6choice_redefine.md b/tests/results/test/16_6choice_redefine.md new file mode 100644 index 0000000..b10bc9a --- /dev/null +++ b/tests/results/test/16_6choice_redefine.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | + diff --git a/tests/results/test/16_6choice_redefine.sh b/tests/results/test/16_6choice_redefine.sh new file mode 100644 index 0000000..19cc753 --- /dev/null +++ b/tests/results/test/16_6choice_redefine.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + choice standard mandatory A choice. + Choices: + + + • a + • c ← (default) + | diff --git a/tests/results/test/16_6exists_redefine_family.adoc b/tests/results/test/16_6exists_redefine_family.adoc new file mode 100644 index 0000000..2097e3d --- /dev/null +++ b/tests/results/test/16_6exists_redefine_family.adoc @@ -0,0 +1,30 @@ +== Variables + +=== new description + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family1.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +=== a second family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family2.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + diff --git a/tests/results/test/16_6exists_redefine_family.json b/tests/results/test/16_6exists_redefine_family.json new file mode 100644 index 0000000..6c6c25c --- /dev/null +++ b/tests/results/test/16_6exists_redefine_family.json @@ -0,0 +1 @@ +{"family1": {"type": "family", "informations": {"paths": ["family1"], "names": ["family1"], "description": "new description", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family1.variable1"], "names": ["variable1"], "descriptions": ["A variable."]}}}, "family2": {"type": "family", "informations": {"paths": ["family2"], "names": ["family2"], "description": "a second family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family2.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/16_6exists_redefine_family.md b/tests/results/test/16_6exists_redefine_family.md new file mode 100644 index 0000000..4f3c331 --- /dev/null +++ b/tests/results/test/16_6exists_redefine_family.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family1.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a second family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family2.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + diff --git a/tests/results/test/16_6exists_redefine_family.sh b/tests/results/test/16_6exists_redefine_family.sh new file mode 100644 index 0000000..4914206 --- /dev/null +++ b/tests/results/test/16_6exists_redefine_family.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family1.variable1 + string basic mandatory A variable. + + + + a second family + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family2.variable2 + string basic mandatory A second variable. + diff --git a/tests/results/test/16exists_exists.adoc b/tests/results/test/16exists_exists.adoc new file mode 100644 index 0000000..3ec538d --- /dev/null +++ b/tests/results/test/16exists_exists.adoc @@ -0,0 +1,12 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Description. +|==== + diff --git a/tests/results/test/16exists_exists.json b/tests/results/test/16exists_exists.json new file mode 100644 index 0000000..a0f7107 --- /dev/null +++ b/tests/results/test/16exists_exists.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["Description."]}} \ No newline at end of file diff --git a/tests/results/test/16exists_exists.md b/tests/results/test/16exists_exists.md new file mode 100644 index 0000000..e9b04b4 --- /dev/null +++ b/tests/results/test/16exists_exists.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | + diff --git a/tests/results/test/16exists_exists.sh b/tests/results/test/16exists_exists.sh new file mode 100644 index 0000000..003d24d --- /dev/null +++ b/tests/results/test/16exists_exists.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory Description. + diff --git a/tests/results/test/17_5redefine_leadership.adoc b/tests/results/test/17_5redefine_leadership.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/17_5redefine_leadership.json b/tests/results/test/17_5redefine_leadership.json similarity index 100% rename from tests/docs/base/17_5redefine_leadership.json rename to tests/results/test/17_5redefine_leadership.json diff --git a/tests/results/test/17_5redefine_leadership.md b/tests/results/test/17_5redefine_leadership.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/17_5redefine_leadership.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/17_5redefine_leadership.sh b/tests/results/test/17_5redefine_leadership.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/20_0empty_family.adoc b/tests/results/test/20_0empty_family.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_0empty_family.json b/tests/results/test/20_0empty_family.json similarity index 100% rename from tests/docs/base/20_0empty_family.json rename to tests/results/test/20_0empty_family.json diff --git a/tests/results/test/20_0empty_family.md b/tests/results/test/20_0empty_family.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/20_0empty_family.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/20_0empty_family.sh b/tests/results/test/20_0empty_family.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/20_0family_append.adoc b/tests/results/test/20_0family_append.adoc new file mode 100644 index 0000000..5e0459e --- /dev/null +++ b/tests/results/test/20_0family_append.adoc @@ -0,0 +1,21 @@ +== Variables + +=== A family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The first variable. +| + +**family.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The second variable. +|==== + diff --git a/tests/results/test/20_0family_append.json b/tests/results/test/20_0family_append.json new file mode 100644 index 0000000..e44d20a --- /dev/null +++ b/tests/results/test/20_0family_append.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "A family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"], "descriptions": ["The first variable."]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var2"], "names": ["var2"], "descriptions": ["The second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/20_0family_append.md b/tests/results/test/20_0family_append.md new file mode 100644 index 0000000..62efce9 --- /dev/null +++ b/tests/results/test/20_0family_append.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A 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. | + diff --git a/tests/results/test/20_0family_append.sh b/tests/results/test/20_0family_append.sh new file mode 100644 index 0000000..bc9fd92 --- /dev/null +++ b/tests/results/test/20_0family_append.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory The first variable. + family.var2 + string basic mandatory The second variable. + diff --git a/tests/results/test/20_0family_underscore.adoc b/tests/results/test/20_0family_underscore.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_0family_underscore.json b/tests/results/test/20_0family_underscore.json similarity index 100% rename from tests/docs/base/20_0family_underscore.json rename to tests/results/test/20_0family_underscore.json diff --git a/tests/results/test/20_0family_underscore.md b/tests/results/test/20_0family_underscore.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/20_0family_underscore.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/20_0family_underscore.sh b/tests/results/test/20_0family_underscore.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/20_0multi_family.adoc b/tests/results/test/20_0multi_family.adoc new file mode 100644 index 0000000..5a73d74 --- /dev/null +++ b/tests/results/test/20_0multi_family.adoc @@ -0,0 +1,20 @@ +== Variables + +=== a family + +`standard` + +==== a sub family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. +|==== + diff --git a/tests/results/test/20_0multi_family.json b/tests/results/test/20_0multi_family.json new file mode 100644 index 0000000..b7f50f5 --- /dev/null +++ b/tests/results/test/20_0multi_family.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/20_0multi_family.md b/tests/results/test/20_0multi_family.md new file mode 100644 index 0000000..158e7ae --- /dev/null +++ b/tests/results/test/20_0multi_family.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`standard` + +### a sub family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + diff --git a/tests/results/test/20_0multi_family.sh b/tests/results/test/20_0multi_family.sh new file mode 100644 index 0000000..121055d --- /dev/null +++ b/tests/results/test/20_0multi_family.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +standard + + a sub family + +standard + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string standard A variable. + diff --git a/tests/results/test/20_0multi_family_basic.adoc b/tests/results/test/20_0multi_family_basic.adoc new file mode 100644 index 0000000..2fae611 --- /dev/null +++ b/tests/results/test/20_0multi_family_basic.adoc @@ -0,0 +1,20 @@ +== Variables + +=== a family + +`basic` + +==== a sub family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/20_0multi_family_basic.json b/tests/results/test/20_0multi_family_basic.json new file mode 100644 index 0000000..ee4ba89 --- /dev/null +++ b/tests/results/test/20_0multi_family_basic.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/20_0multi_family_basic.md b/tests/results/test/20_0multi_family_basic.md new file mode 100644 index 0000000..42095bb --- /dev/null +++ b/tests/results/test/20_0multi_family_basic.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/20_0multi_family_basic.sh b/tests/results/test/20_0multi_family_basic.sh new file mode 100644 index 0000000..2248b05 --- /dev/null +++ b/tests/results/test/20_0multi_family_basic.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + a sub family + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string basic mandatory A variable. + diff --git a/tests/results/test/20_0multi_family_expert.adoc b/tests/results/test/20_0multi_family_expert.adoc new file mode 100644 index 0000000..d3623d4 --- /dev/null +++ b/tests/results/test/20_0multi_family_expert.adoc @@ -0,0 +1,20 @@ +== Variables + +=== a family + +`advanced` + +==== a sub family + +`advanced` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `advanced` | +A variable. +|==== + diff --git a/tests/results/test/20_0multi_family_expert.json b/tests/results/test/20_0multi_family_expert.json new file mode 100644 index 0000000..3bbc3e2 --- /dev/null +++ b/tests/results/test/20_0multi_family_expert.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "advanced"}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "advanced"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "advanced"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/20_0multi_family_expert.md b/tests/results/test/20_0multi_family_expert.md new file mode 100644 index 0000000..9767ed4 --- /dev/null +++ b/tests/results/test/20_0multi_family_expert.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`advanced` + +### a sub family + +`advanced` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` | A variable. | + diff --git a/tests/results/test/20_0multi_family_expert.sh b/tests/results/test/20_0multi_family_expert.sh new file mode 100644 index 0000000..8efffb8 --- /dev/null +++ b/tests/results/test/20_0multi_family_expert.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +advanced + + a sub family + +advanced + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string advanced A variable. + diff --git a/tests/results/test/20_0multi_family_order.adoc b/tests/results/test/20_0multi_family_order.adoc new file mode 100644 index 0000000..9b71321 --- /dev/null +++ b/tests/results/test/20_0multi_family_order.adoc @@ -0,0 +1,50 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +=== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +|==== + +==== a sub family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + diff --git a/tests/results/test/20_0multi_family_order.json b/tests/results/test/20_0multi_family_order.json new file mode 100644 index 0000000..4a6bfec --- /dev/null +++ b/tests/results/test/20_0multi_family_order.json @@ -0,0 +1 @@ +{"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["variable"], "names": ["variable"], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable1"], "names": ["variable1"], "descriptions": ["A first variable."]}, "subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a sub family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.variable"], "names": ["variable"], "descriptions": ["A variable."]}}}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/20_0multi_family_order.md b/tests/results/test/20_0multi_family_order.md new file mode 100644 index 0000000..ba84c5b --- /dev/null +++ b/tests/results/test/20_0multi_family_order.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + +### 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.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + diff --git a/tests/results/test/20_0multi_family_order.sh b/tests/results/test/20_0multi_family_order.sh new file mode 100644 index 0000000..5d520bb --- /dev/null +++ b/tests/results/test/20_0multi_family_order.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + variable + string basic mandatory A variable. + + + + a family + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable1 + string basic mandatory A first variable. + + + a sub family + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.variable + string basic mandatory A variable. + + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.variable2 + string basic mandatory A second variable. + diff --git a/tests/results/test/20_0validators_differ_redefine.adoc b/tests/results/test/20_0validators_differ_redefine.adoc new file mode 100644 index 0000000..8638bab --- /dev/null +++ b/tests/results/test/20_0validators_differ_redefine.adoc @@ -0,0 +1,27 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A first variable. + +**Default**: no +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Validator**: var3 must be different than var2. + +**Default**: yes + +**Example**: yes +|==== + diff --git a/tests/results/test/20_0validators_differ_redefine.json b/tests/results/test/20_0validators_differ_redefine.json new file mode 100644 index 0000000..565c32a --- /dev/null +++ b/tests/results/test/20_0validators_differ_redefine.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "validators": ["var3 must be different than var2."], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."], "examples": ["yes"]}} \ No newline at end of file diff --git a/tests/results/test/20_0validators_differ_redefine.md b/tests/results/test/20_0validators_differ_redefine.md new file mode 100644 index 0000000..95d575c --- /dev/null +++ b/tests/results/test/20_0validators_differ_redefine.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# 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
**Example**: yes | + diff --git a/tests/results/test/20_0validators_differ_redefine.sh b/tests/results/test/20_0validators_differ_redefine.sh new file mode 100644 index 0000000..d4313b6 --- /dev/null +++ b/tests/results/test/20_0validators_differ_redefine.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory A first variable. + Default: no + var2 + string standard mandatory A second variable. + Default: no + var3 + string standard mandatory A third variable. + Validator: var3 must be different + than var2. + Default: yes + Example: yes + diff --git a/tests/results/test/20_1empty_subfamily.adoc b/tests/results/test/20_1empty_subfamily.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_1empty_subfamily.json b/tests/results/test/20_1empty_subfamily.json similarity index 100% rename from tests/docs/base/20_1empty_subfamily.json rename to tests/results/test/20_1empty_subfamily.json diff --git a/tests/results/test/20_1empty_subfamily.md b/tests/results/test/20_1empty_subfamily.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/20_1empty_subfamily.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/20_1empty_subfamily.sh b/tests/results/test/20_1empty_subfamily.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/20_9default_information_parent.adoc b/tests/results/test/20_9default_information_parent.adoc new file mode 100644 index 0000000..c319d30 --- /dev/null +++ b/tests/results/test/20_9default_information_parent.adoc @@ -0,0 +1,22 @@ +== Variables + +=== family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A first variable. +| + +**family.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of the information "test_information" of the variable "family". +|==== + diff --git a/tests/results/test/20_9default_information_parent.json b/tests/results/test/20_9default_information_parent.json new file mode 100644 index 0000000..1771134 --- /dev/null +++ b/tests/results/test/20_9default_information_parent.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var1"], "names": ["var1"], "descriptions": ["A first variable."]}, "var2": {"type": "variable", "default": "the value of the information \"test_information\" of the variable \"family\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/20_9default_information_parent.md b/tests/results/test/20_9default_information_parent.md new file mode 100644 index 0000000..b784d4f --- /dev/null +++ b/tests/results/test/20_9default_information_parent.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## 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**: the value of the information "test_information" of the variable "family". | + diff --git a/tests/results/test/20_9default_information_parent.sh b/tests/results/test/20_9default_information_parent.sh new file mode 100644 index 0000000..0163395 --- /dev/null +++ b/tests/results/test/20_9default_information_parent.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + family + +basic + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var1 + string basic mandatory A first variable. + family.var2 + string standard mandatory A second variable. + Default: the value of the information + "test_information" of the variable + "family". + diff --git a/tests/results/test/24_0family_hidden_condition_sub_family.adoc b/tests/results/test/24_0family_hidden_condition_sub_family.adoc new file mode 100644 index 0000000..9c728db --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_sub_family.adoc @@ -0,0 +1,34 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` `__hidden__` + + +**Hidden**: if condition is yes. + +==== family.subfamily + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/24_0family_hidden_condition_sub_family.json b/tests/results/test/24_0family_hidden_condition_sub_family.json new file mode 100644 index 0000000..d0c9df8 --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/24_0family_hidden_condition_sub_family.md b/tests/results/test/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..7cd2a8d --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: if condition is yes. + +### family.subfamily + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/24_0family_hidden_condition_sub_family.sh b/tests/results/test/24_0family_hidden_condition_sub_family.sh new file mode 100644 index 0000000..8f30626 --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + family.subfamily + +basic + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.var1 + string basic mandatory A variable. + diff --git a/tests/results/test/24_0family_hidden_condition_variable_sub_family.adoc b/tests/results/test/24_0family_hidden_condition_variable_sub_family.adoc new file mode 100644 index 0000000..75335ac --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_variable_sub_family.adoc @@ -0,0 +1,34 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +The variable use has condition. + +**Default**: true +|==== + +=== possibly hidden family + +`standard` `__hidden__` + + +**Hidden**: when the variable "condition" has the value "true". + +==== a subfamily + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.subfamily.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. +|==== + diff --git a/tests/results/test/24_0family_hidden_condition_variable_sub_family.json b/tests/results/test/24_0family_hidden_condition_variable_sub_family.json new file mode 100644 index 0000000..fb24ef8 --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_variable_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "when the variable \"condition\" has the value \"true\"."}]}, "children": {"subfamily": {"type": "family", "informations": {"paths": ["family.subfamily"], "names": ["subfamily"], "description": "a subfamily", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["family.subfamily.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/24_0family_hidden_condition_variable_sub_family.md b/tests/results/test/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..ecec624 --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: true | + +## possibly hidden family + +`standard` *`hidden`* + +**Hidden**: when the variable "condition" has the value "true". + +### a subfamily + +`standard` + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + diff --git a/tests/results/test/24_0family_hidden_condition_variable_sub_family.sh b/tests/results/test/24_0family_hidden_condition_variable_sub_family.sh new file mode 100644 index 0000000..6f6f30f --- /dev/null +++ b/tests/results/test/24_0family_hidden_condition_variable_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory The variable use has condition. + Default: true + + + + possibly hidden family + +standard hidden + +Hidden: when the variable "condition" has the value "true". + + a subfamily + +standard + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.subfamily.var1 + string standard A variable. + diff --git a/tests/results/test/24_0family_hidden_param_condition_sub_family.adoc b/tests/results/test/24_0family_hidden_param_condition_sub_family.adoc new file mode 100644 index 0000000..4258113 --- /dev/null +++ b/tests/results/test/24_0family_hidden_param_condition_sub_family.adoc @@ -0,0 +1,34 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +The variable use has condition. + +**Default**: no +|==== + +=== possibly hidden family + +`basic` `__hidden__` + + +**Hidden**: if condition is yes. + +==== a subfamily + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.sub_family.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + diff --git a/tests/results/test/24_0family_hidden_param_condition_sub_family.json b/tests/results/test/24_0family_hidden_param_condition_sub_family.json new file mode 100644 index 0000000..6045645 --- /dev/null +++ b/tests/results/test/24_0family_hidden_param_condition_sub_family.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["The variable use has condition."]}, "family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "possibly hidden family", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is yes."}]}, "children": {"sub_family": {"type": "family", "informations": {"paths": ["family.sub_family"], "names": ["sub_family"], "description": "a subfamily", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.sub_family.var1"], "names": ["var1"], "descriptions": ["A variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/24_0family_hidden_param_condition_sub_family.md b/tests/results/test/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..959304a --- /dev/null +++ b/tests/results/test/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: if condition is yes. + +### a subfamily + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test/24_0family_hidden_param_condition_sub_family.sh b/tests/results/test/24_0family_hidden_param_condition_sub_family.sh new file mode 100644 index 0000000..6fbe9d8 --- /dev/null +++ b/tests/results/test/24_0family_hidden_param_condition_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + a subfamily + +basic + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.sub_family.var1 + string basic mandatory A variable. + diff --git a/tests/results/test/24_0family_mandatory_condition.adoc b/tests/results/test/24_0family_mandatory_condition.adoc new file mode 100644 index 0000000..49da3f1 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__mandatory__` | +A variable. + +**Mandatory**: only if rougail.condition has the value "yes". +|==== + diff --git a/tests/results/test/24_0family_mandatory_condition.json b/tests/results/test/24_0family_mandatory_condition.json new file mode 100644 index 0000000..8c8cf6e --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "only if rougail.condition has the value \"yes\"."}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/24_0family_mandatory_condition.md b/tests/results/test/24_0family_mandatory_condition.md new file mode 100644 index 0000000..310d640 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/24_0family_mandatory_condition.sh b/tests/results/test/24_0family_mandatory_condition.sh new file mode 100644 index 0000000..a29cf96 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + var + string standard mandatory A variable. + Mandatory: only if rougail.condition + has the value "yes". + diff --git a/tests/results/test/24_0family_mandatory_condition_variable.adoc b/tests/results/test/24_0family_mandatory_condition_variable.adoc new file mode 100644 index 0000000..023b461 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition_variable.adoc @@ -0,0 +1,19 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: true +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__mandatory__` | +A variable. + +**Mandatory**: when the variable "condition" has the value "true". +|==== + diff --git a/tests/results/test/24_0family_mandatory_condition_variable.json b/tests/results/test/24_0family_mandatory_condition_variable.json new file mode 100644 index 0000000..2a3b763 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition_variable.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": true, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory", "annotation": "when the variable \"condition\" has the value \"true\"."}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/24_0family_mandatory_condition_variable.md b/tests/results/test/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..4e7750c --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + diff --git a/tests/results/test/24_0family_mandatory_condition_variable.sh b/tests/results/test/24_0family_mandatory_condition_variable.sh new file mode 100644 index 0000000..ac587c3 --- /dev/null +++ b/tests/results/test/24_0family_mandatory_condition_variable.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: true + var + string standard mandatory A variable. + Mandatory: when the variable + "condition" has the value "true". + diff --git a/tests/results/test/24_7validators_variable_optional.adoc b/tests/results/test/24_7validators_variable_optional.adoc new file mode 100644 index 0000000..4765720 --- /dev/null +++ b/tests/results/test/24_7validators_variable_optional.adoc @@ -0,0 +1,28 @@ +== Variables + +=== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**general.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A first number. + +**Validators**: + +* int and int2 must be different. +* int and int3 must be different. + +**Example**: 5 +| + +**general.int2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A second number. + +**Default**: 1 +|==== + diff --git a/tests/results/test/24_7validators_variable_optional.json b/tests/results/test/24_7validators_variable_optional.json new file mode 100644 index 0000000..cb93400 --- /dev/null +++ b/tests/results/test/24_7validators_variable_optional.json @@ -0,0 +1 @@ +{"general": {"type": "family", "informations": {"paths": ["general"], "names": ["general"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"int": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["int and int2 must be different.", "int and int3 must be different."], "paths": ["general.int"], "names": ["int"], "descriptions": ["A first number."], "examples": [5]}, "int2": {"type": "variable", "default": 1, "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["general.int2"], "names": ["int2"], "descriptions": ["A second number."]}}}} \ No newline at end of file diff --git a/tests/results/test/24_7validators_variable_optional.md b/tests/results/test/24_7validators_variable_optional.md new file mode 100644 index 0000000..a3f635a --- /dev/null +++ b/tests/results/test/24_7validators_variable_optional.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## 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.
**Example**: 5 | +| **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | + diff --git a/tests/results/test/24_7validators_variable_optional.sh b/tests/results/test/24_7validators_variable_optional.sh new file mode 100644 index 0000000..03f2c8a --- /dev/null +++ b/tests/results/test/24_7validators_variable_optional.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general.int + number basic mandatory A first number. + Validators: + + + • int and int2 must be different. + • int and int3 must be different. Example: 5 + | | general.int2 number standard mandatory + | A second number. Default: 1 + | diff --git a/tests/results/test/24_family_disabled_var_hidden.adoc b/tests/results/test/24_family_disabled_var_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/24_family_disabled_var_hidden.json b/tests/results/test/24_family_disabled_var_hidden.json similarity index 100% rename from tests/docs/base/24_family_disabled_var_hidden.json rename to tests/results/test/24_family_disabled_var_hidden.json diff --git a/tests/results/test/24_family_disabled_var_hidden.md b/tests/results/test/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/24_family_disabled_var_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/24_family_disabled_var_hidden.sh b/tests/results/test/24_family_disabled_var_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/40_0leadership.adoc b/tests/results/test/40_0leadership.adoc new file mode 100644 index 0000000..8d67b9f --- /dev/null +++ b/tests/results/test/40_0leadership.adoc @@ -0,0 +1,28 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + diff --git a/tests/results/test/40_0leadership.json b/tests/results/test/40_0leadership.json new file mode 100644 index 0000000..f2a8473 --- /dev/null +++ b/tests/results/test/40_0leadership.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_0leadership.md b/tests/results/test/40_0leadership.md new file mode 100644 index 0000000..42799e3 --- /dev/null +++ b/tests/results/test/40_0leadership.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/40_0leadership.sh b/tests/results/test/40_0leadership.sh new file mode 100644 index 0000000..a62ebb3 --- /dev/null +++ b/tests/results/test/40_0leadership.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique A leader. + multiple + leader.follower1 + string basic mandatory A follower. + leader.follower2 + string basic mandatory An other follower. + diff --git a/tests/results/test/40_0leadership_diff_name.adoc b/tests/results/test/40_0leadership_diff_name.adoc new file mode 100644 index 0000000..1b51117 --- /dev/null +++ b/tests/results/test/40_0leadership_diff_name.adoc @@ -0,0 +1,28 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower. +| + +**leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +An other follower. +|==== + diff --git a/tests/results/test/40_0leadership_diff_name.json b/tests/results/test/40_0leadership_diff_name.json new file mode 100644 index 0000000..0fee048 --- /dev/null +++ b/tests/results/test/40_0leadership_diff_name.json @@ -0,0 +1 @@ +{"leadership": {"type": "leadership", "informations": {"paths": ["leadership"], "names": ["leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leadership.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leadership.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_0leadership_diff_name.md b/tests/results/test/40_0leadership_diff_name.md new file mode 100644 index 0000000..f1140d9 --- /dev/null +++ b/tests/results/test/40_0leadership_diff_name.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/40_0leadership_diff_name.sh b/tests/results/test/40_0leadership_diff_name.sh new file mode 100644 index 0000000..2fa3860 --- /dev/null +++ b/tests/results/test/40_0leadership_diff_name.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leadership.leader + string basic mandatory unique A leader. + multiple + leadership.follower1 + string basic mandatory A follower. + leadership.follower2 + string basic mandatory An other follower. + diff --git a/tests/results/test/40_0leadership_empty.adoc b/tests/results/test/40_0leadership_empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/40_0leadership_empty.json b/tests/results/test/40_0leadership_empty.json similarity index 100% rename from tests/docs/base/40_0leadership_empty.json rename to tests/results/test/40_0leadership_empty.json diff --git a/tests/results/test/40_0leadership_empty.md b/tests/results/test/40_0leadership_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/40_0leadership_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/40_0leadership_empty.sh b/tests/results/test/40_0leadership_empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/40_0leadership_follower_default_calculation.adoc b/tests/results/test/40_0leadership_follower_default_calculation.adoc new file mode 100644 index 0000000..6322f14 --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_calculation.adoc @@ -0,0 +1,30 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: value +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second follower. + +**Default**: returns follower1 value. +|==== + diff --git a/tests/results/test/40_0leadership_follower_default_calculation.json b/tests/results/test/40_0leadership_follower_default_calculation.json new file mode 100644 index 0000000..c907577 --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_calculation.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "returns follower1 value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["A second follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_0leadership_follower_default_calculation.md b/tests/results/test/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..ea3350d --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_calculation.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/40_0leadership_follower_default_calculation.sh b/tests/results/test/40_0leadership_follower_default_calculation.sh new file mode 100644 index 0000000..ff4c8a4 --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_calculation.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique A leader. + multiple + leader.follower1 + string standard mandatory A follower. + Default: value + leader.follower2 + string standard mandatory A second follower. + Default: returns follower1 value. + diff --git a/tests/results/test/40_0leadership_follower_default_value.adoc b/tests/results/test/40_0leadership_follower_default_value.adoc new file mode 100644 index 0000000..273a787 --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_value.adoc @@ -0,0 +1,24 @@ +== Variables + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.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` | +A follower with default value. + +**Default**: value +|==== + diff --git a/tests/results/test/40_0leadership_follower_default_value.json b/tests/results/test/40_0leadership_follower_default_value.json new file mode 100644 index 0000000..e0b3abe --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_value.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower with default value."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_0leadership_follower_default_value.md b/tests/results/test/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..60a53e3 --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_value.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`standard` + +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 | + diff --git a/tests/results/test/40_0leadership_follower_default_value.sh b/tests/results/test/40_0leadership_follower_default_value.sh new file mode 100644 index 0000000..d6db60c --- /dev/null +++ b/tests/results/test/40_0leadership_follower_default_value.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower1 + string standard mandatory A follower with default value. + Default: value + diff --git a/tests/results/test/40_0leadership_leader_not_multi.adoc b/tests/results/test/40_0leadership_leader_not_multi.adoc new file mode 100644 index 0000000..54eae5c --- /dev/null +++ b/tests/results/test/40_0leadership_leader_not_multi.adoc @@ -0,0 +1,47 @@ +== Variables + +=== general + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**general.mode_conteneur_actif** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +No change. + +**Default**: non +|==== + +=== general1 + +`basic` + +==== general1.leader + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**general1.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +Leader. +| + +**general1.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower1. +| + +**general1.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Follower2. +|==== + diff --git a/tests/results/test/40_0leadership_leader_not_multi.json b/tests/results/test/40_0leadership_leader_not_multi.json new file mode 100644 index 0000000..9571ce4 --- /dev/null +++ b/tests/results/test/40_0leadership_leader_not_multi.json @@ -0,0 +1 @@ +{"general": {"type": "family", "informations": {"paths": ["general"], "names": ["general"], "properties": [{"type": "mode", "name": "standard"}]}, "children": {"mode_conteneur_actif": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["general.mode_conteneur_actif"], "names": ["mode_conteneur_actif"], "descriptions": ["No change."]}}}, "general1": {"type": "family", "informations": {"paths": ["general1"], "names": ["general1"], "properties": [{"type": "mode", "name": "basic"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["general1.leader"], "names": ["leader"], "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["general1.leader.leader"], "names": ["leader"], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["general1.leader.follower1"], "names": ["follower1"]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["general1.leader.follower2"], "names": ["follower2"]}}}}}} \ No newline at end of file diff --git a/tests/results/test/40_0leadership_leader_not_multi.md b/tests/results/test/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..b67f10f --- /dev/null +++ b/tests/results/test/40_0leadership_leader_not_multi.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## general + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: 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` `mandatory` `unique` `multiple` | Leader. | +| **general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | +| **general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | + diff --git a/tests/results/test/40_0leadership_leader_not_multi.sh b/tests/results/test/40_0leadership_leader_not_multi.sh new file mode 100644 index 0000000..640ae17 --- /dev/null +++ b/tests/results/test/40_0leadership_leader_not_multi.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + general + +standard + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general.mode_conteneur_actif + string standard mandatory No change. + Default: non + + + + general1 + +basic + + general1.leader + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + general1.leader.leader + string basic mandatory unique Leader. + multiple + general1.leader.follower1 + string basic mandatory Follower1. + general1.leader.follower2 + string basic mandatory Follower2. + diff --git a/tests/results/test/40_1leadership_append_follower.adoc b/tests/results/test/40_1leadership_append_follower.adoc new file mode 100644 index 0000000..f671574 --- /dev/null +++ b/tests/results/test/40_1leadership_append_follower.adoc @@ -0,0 +1,33 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower1. +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower2. +| + +**leader.follower3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +The follower3. +|==== + diff --git a/tests/results/test/40_1leadership_append_follower.json b/tests/results/test/40_1leadership_append_follower.json new file mode 100644 index 0000000..352f24d --- /dev/null +++ b/tests/results/test/40_1leadership_append_follower.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["The follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["The follower2."]}, "follower3": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower3"], "names": ["follower3"], "descriptions": ["The follower3."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_1leadership_append_follower.md b/tests/results/test/40_1leadership_append_follower.md new file mode 100644 index 0000000..d618e6c --- /dev/null +++ b/tests/results/test/40_1leadership_append_follower.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/40_1leadership_append_follower.sh b/tests/results/test/40_1leadership_append_follower.sh new file mode 100644 index 0000000..55eb4c4 --- /dev/null +++ b/tests/results/test/40_1leadership_append_follower.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique The leader. + multiple + leader.follower1 + string basic mandatory The follower1. + leader.follower2 + string basic mandatory The follower2. + leader.follower3 + string basic mandatory The follower3. + diff --git a/tests/results/test/40_6leadership_follower_multi.adoc b/tests/results/test/40_6leadership_follower_multi.adoc new file mode 100644 index 0000000..3dfad69 --- /dev/null +++ b/tests/results/test/40_6leadership_follower_multi.adoc @@ -0,0 +1,29 @@ +== Variables + +=== A leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +The leader. +| + +**leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `multiple` | +The first follower. +| + +**leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +The second follower. + +**Default**: value +|==== + diff --git a/tests/results/test/40_6leadership_follower_multi.json b/tests/results/test/40_6leadership_follower_multi.json new file mode 100644 index 0000000..0778bf6 --- /dev/null +++ b/tests/results/test/40_6leadership_follower_multi.json @@ -0,0 +1 @@ +{"leadership": {"type": "leadership", "informations": {"paths": ["leadership"], "names": ["leadership"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.follower1"], "names": ["follower1"], "descriptions": ["The first follower."], "multiple": true}, "follower2": {"type": "variable", "default": ["value"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["leadership.follower2"], "names": ["follower2"], "descriptions": ["The second follower."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test/40_6leadership_follower_multi.md b/tests/results/test/40_6leadership_follower_multi.md new file mode 100644 index 0000000..18134cf --- /dev/null +++ b/tests/results/test/40_6leadership_follower_multi.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A leadership + +`basic` + +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 | + diff --git a/tests/results/test/40_6leadership_follower_multi.sh b/tests/results/test/40_6leadership_follower_multi.sh new file mode 100644 index 0000000..1bb63cf --- /dev/null +++ b/tests/results/test/40_6leadership_follower_multi.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leadership.leader + string basic mandatory unique The leader. + multiple + leadership.follower1 + string basic mandatory multiple The first follower. + leadership.follower2 + string standard mandatory multiple The second follower. + Default: value + diff --git a/tests/results/test/40_8calculation_boolean.adoc b/tests/results/test/40_8calculation_boolean.adoc new file mode 100644 index 0000000..4765a6a --- /dev/null +++ b/tests/results/test/40_8calculation_boolean.adoc @@ -0,0 +1,25 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**bool** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A boolean variable. + +**Default**: false +| + +**multi1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A first multi variable. + +**Default**: a calculation. +| + +**multi2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` `unique` `multiple` | +A second multi variable. + +**Default**: a calculation. +|==== + diff --git a/tests/results/test/40_8calculation_boolean.json b/tests/results/test/40_8calculation_boolean.json new file mode 100644 index 0000000..6092c16 --- /dev/null +++ b/tests/results/test/40_8calculation_boolean.json @@ -0,0 +1 @@ +{"bool": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["bool"], "names": ["bool"], "descriptions": ["A boolean variable."]}, "multi1": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["multi1"], "names": ["multi1"], "descriptions": ["A first multi variable."], "multiple": true}, "multi2": {"type": "variable", "default": "a calculation.", "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["multi2"], "names": ["multi2"], "descriptions": ["A second multi variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/40_8calculation_boolean.md b/tests/results/test/40_8calculation_boolean.md new file mode 100644 index 0000000..c152b66 --- /dev/null +++ b/tests/results/test/40_8calculation_boolean.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + diff --git a/tests/results/test/40_8calculation_boolean.sh b/tests/results/test/40_8calculation_boolean.sh new file mode 100644 index 0000000..c16eb8e --- /dev/null +++ b/tests/results/test/40_8calculation_boolean.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + bool + boolean standard mandatory A boolean variable. + Default: false + multi1 + boolean standard mandatory unique A first multi variable. + multiple + Default: a calculation. + multi2 + boolean standard mandatory unique A second multi variable. + multiple + Default: a calculation. + diff --git a/tests/results/test/40_8calculation_multi_variable.adoc b/tests/results/test/40_8calculation_multi_variable.adoc new file mode 100644 index 0000000..6252c8b --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable.adoc @@ -0,0 +1,28 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A first variable. + +**Default**: + +* the value of the variable "var2". +* the value of the variable "var3". +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +| + +**var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A third variable. + +**Default**: yes +|==== + diff --git a/tests/results/test/40_8calculation_multi_variable.json b/tests/results/test/40_8calculation_multi_variable.json new file mode 100644 index 0000000..3041336 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["the value of the variable \"var2\".", "the value of the variable \"var3\"."], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A first variable."], "multiple": true}, "var2": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "var3": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var3"], "names": ["var3"], "descriptions": ["A third variable."]}} \ No newline at end of file diff --git a/tests/results/test/40_8calculation_multi_variable.md b/tests/results/test/40_8calculation_multi_variable.md new file mode 100644 index 0000000..1a7ebf7 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + diff --git a/tests/results/test/40_8calculation_multi_variable.sh b/tests/results/test/40_8calculation_multi_variable.sh new file mode 100644 index 0000000..ce17a00 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A first variable. + multiple + Default: + + + • the value of the variable "var2". + • the value of the variable "var3". + | | var2 string standard mandatory + | A second variable. Default: no + | | var3 string standard mandatory + | A third variable. Default: yes + | diff --git a/tests/results/test/40_8calculation_multi_variable_parent.adoc b/tests/results/test/40_8calculation_multi_variable_parent.adoc new file mode 100644 index 0000000..81c08c8 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent.adoc @@ -0,0 +1,28 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== a family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: the value of the variable "var". +|==== + diff --git a/tests/results/test/40_8calculation_multi_variable_parent.json b/tests/results/test/40_8calculation_multi_variable_parent.json new file mode 100644 index 0000000..0dd64f7 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A variable."]}, "fam1": {"type": "family", "informations": {"paths": ["fam1"], "names": ["fam1"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam1.var"], "names": ["var"], "descriptions": ["A calculated variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_8calculation_multi_variable_parent.md b/tests/results/test/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..39d75e1 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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". | + diff --git a/tests/results/test/40_8calculation_multi_variable_parent.sh b/tests/results/test/40_8calculation_multi_variable_parent.sh new file mode 100644 index 0000000..3299ae1 --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A variable. + Default: no + + + + a family + +standard + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam1.var + string standard mandatory A calculated variable. + Default: the value of the variable + "var". + diff --git a/tests/results/test/40_8calculation_multi_variable_parent2.adoc b/tests/results/test/40_8calculation_multi_variable_parent2.adoc new file mode 100644 index 0000000..c4ce78b --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent2.adoc @@ -0,0 +1,32 @@ +== Variables + +=== first family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**fam1.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: no +|==== + +=== second family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**fam2.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varaible. + +**Default**: the value of the variable "fam1.var". +|==== + diff --git a/tests/results/test/40_8calculation_multi_variable_parent2.json b/tests/results/test/40_8calculation_multi_variable_parent2.json new file mode 100644 index 0000000..3c1ba4f --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent2.json @@ -0,0 +1 @@ +{"fam1": {"type": "family", "informations": {"paths": ["fam1"], "names": ["fam1"], "description": "first family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam1.var"], "names": ["var"], "descriptions": ["A variable."]}}}, "fam2": {"type": "family", "informations": {"paths": ["fam2"], "names": ["fam2"], "description": "second family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": "the value of the variable \"fam1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["fam2.var"], "names": ["var"], "descriptions": ["A varaible."]}}}} \ No newline at end of file diff --git a/tests/results/test/40_8calculation_multi_variable_parent2.md b/tests/results/test/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..3e5e80e --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## first family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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". | + diff --git a/tests/results/test/40_8calculation_multi_variable_parent2.sh b/tests/results/test/40_8calculation_multi_variable_parent2.sh new file mode 100644 index 0000000..66e89ac --- /dev/null +++ b/tests/results/test/40_8calculation_multi_variable_parent2.sh @@ -0,0 +1,34 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + first family + +standard + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam1.var + string standard mandatory A variable. + Default: no + + + + second family + +standard + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + fam2.var + string standard mandatory A varaible. + Default: the value of the variable + "fam1.var". + diff --git a/tests/results/test/41_0choice_leader.adoc b/tests/results/test/41_0choice_leader.adoc new file mode 100644 index 0000000..da6665a --- /dev/null +++ b/tests/results/test/41_0choice_leader.adoc @@ -0,0 +1,28 @@ +== Variables + +=== The leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.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` | +A follower. + +**Choices**: + +* a +* b +* c +|==== + diff --git a/tests/results/test/41_0choice_leader.json b/tests/results/test/41_0choice_leader.json new file mode 100644 index 0000000..b899d1b --- /dev/null +++ b/tests/results/test/41_0choice_leader.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "The leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["The leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "choice"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "choices": ["a", "b", "c"], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/41_0choice_leader.md b/tests/results/test/41_0choice_leader.md new file mode 100644 index 0000000..8a4cbd6 --- /dev/null +++ b/tests/results/test/41_0choice_leader.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## The leadership + +`basic` + +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 | + diff --git a/tests/results/test/41_0choice_leader.sh b/tests/results/test/41_0choice_leader.sh new file mode 100644 index 0000000..e8e8875 --- /dev/null +++ b/tests/results/test/41_0choice_leader.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + The leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple The leader. + leader.follower1 + choice basic mandatory A follower. + Choices: + + + • a + • b + • c + | diff --git a/tests/results/test/44_0leadership_hidden.adoc b/tests/results/test/44_0leadership_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/44_0leadership_hidden.json b/tests/results/test/44_0leadership_hidden.json similarity index 100% rename from tests/docs/base/44_0leadership_hidden.json rename to tests/results/test/44_0leadership_hidden.json diff --git a/tests/results/test/44_0leadership_hidden.md b/tests/results/test/44_0leadership_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/44_0leadership_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/44_0leadership_hidden.sh b/tests/results/test/44_0leadership_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/44_0leadership_leader_hidden.adoc b/tests/results/test/44_0leadership_leader_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/44_0leadership_leader_hidden.json b/tests/results/test/44_0leadership_leader_hidden.json similarity index 100% rename from tests/docs/base/44_0leadership_leader_hidden.json rename to tests/results/test/44_0leadership_leader_hidden.json diff --git a/tests/results/test/44_0leadership_leader_hidden.md b/tests/results/test/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/44_0leadership_leader_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/44_0leadership_leader_hidden.sh b/tests/results/test/44_0leadership_leader_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/44_1leadership_append_hidden_follower.adoc b/tests/results/test/44_1leadership_append_hidden_follower.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.json b/tests/results/test/44_1leadership_append_hidden_follower.json similarity index 100% rename from tests/docs/base/44_1leadership_append_hidden_follower.json rename to tests/results/test/44_1leadership_append_hidden_follower.json diff --git a/tests/results/test/44_1leadership_append_hidden_follower.md b/tests/results/test/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/44_1leadership_append_hidden_follower.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/44_1leadership_append_hidden_follower.sh b/tests/results/test/44_1leadership_append_hidden_follower.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/44_4leadership_mandatory.adoc b/tests/results/test/44_4leadership_mandatory.adoc new file mode 100644 index 0000000..c8f00e9 --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory.adoc @@ -0,0 +1,23 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower. +|==== + diff --git a/tests/results/test/44_4leadership_mandatory.json b/tests/results/test/44_4leadership_mandatory.json new file mode 100644 index 0000000..2024426 --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/44_4leadership_mandatory.md b/tests/results/test/44_4leadership_mandatory.md new file mode 100644 index 0000000..046b963 --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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` | A follower. | + diff --git a/tests/results/test/44_4leadership_mandatory.sh b/tests/results/test/44_4leadership_mandatory.sh new file mode 100644 index 0000000..028a01d --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique A leader. + multiple + leader.follower1 + string standard A follower. + diff --git a/tests/results/test/44_4leadership_mandatory_follower.adoc b/tests/results/test/44_4leadership_mandatory_follower.adoc new file mode 100644 index 0000000..b72685c --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory_follower.adoc @@ -0,0 +1,23 @@ +== Variables + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.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. +|==== + diff --git a/tests/results/test/44_4leadership_mandatory_follower.json b/tests/results/test/44_4leadership_mandatory_follower.json new file mode 100644 index 0000000..1cce06f --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory_follower.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/44_4leadership_mandatory_follower.md b/tests/results/test/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..7ffd7a2 --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory_follower.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/44_4leadership_mandatory_follower.sh b/tests/results/test/44_4leadership_mandatory_follower.sh new file mode 100644 index 0000000..c8d867d --- /dev/null +++ b/tests/results/test/44_4leadership_mandatory_follower.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower + string basic mandatory A follower. + diff --git a/tests/results/test/44_5leadership_leader_hidden_calculation.adoc b/tests/results/test/44_5leadership_leader_hidden_calculation.adoc new file mode 100644 index 0000000..8064713 --- /dev/null +++ b/tests/results/test/44_5leadership_leader_hidden_calculation.adoc @@ -0,0 +1,37 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +|==== + +=== a leadership + +`basic` `__hidden__` + + +**Hidden**: if condition is no. + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.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. +|==== + diff --git a/tests/results/test/44_5leadership_leader_hidden_calculation.json b/tests/results/test/44_5leadership_leader_hidden_calculation.json new file mode 100644 index 0000000..3198b96 --- /dev/null +++ b/tests/results/test/44_5leadership_leader_hidden_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}, {"type": "property", "name": "hidden", "annotation": "if condition is no."}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/44_5leadership_leader_hidden_calculation.md b/tests/results/test/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..9cdf97f --- /dev/null +++ b/tests/results/test/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | + +## a leadership + +`basic` *`hidden`* + +**Hidden**: if condition is no. + +This family contains lists of variable blocks. + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](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. | + diff --git a/tests/results/test/44_5leadership_leader_hidden_calculation.sh b/tests/results/test/44_5leadership_leader_hidden_calculation.sh new file mode 100644 index 0000000..848891a --- /dev/null +++ b/tests/results/test/44_5leadership_leader_hidden_calculation.sh @@ -0,0 +1,33 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: no + + + + a leadership + +basic hidden + +Hidden: if condition is no. + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard unique multiple A leader. + leader.follower + string basic mandatory A follower. + diff --git a/tests/results/test/44_6leadership_follower_disabled_calculation.adoc b/tests/results/test/44_6leadership_follower_disabled_calculation.adoc new file mode 100644 index 0000000..9693913 --- /dev/null +++ b/tests/results/test/44_6leadership_follower_disabled_calculation.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: yes +|==== + +=== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**leader.follower** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` | +A follower. + +**Disabled**: if condition is yes. +|==== + diff --git a/tests/results/test/44_6leadership_follower_disabled_calculation.json b/tests/results/test/44_6leadership_follower_disabled_calculation.json new file mode 100644 index 0000000..7bc4562 --- /dev/null +++ b/tests/results/test/44_6leadership_follower_disabled_calculation.json @@ -0,0 +1 @@ +{"condition": {"type": "variable", "default": "yes", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["condition"], "names": ["condition"], "descriptions": ["A condition."]}, "leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is yes."}], "paths": ["leader.follower"], "names": ["follower"], "descriptions": ["A follower."]}}}} \ No newline at end of file diff --git a/tests/results/test/44_6leadership_follower_disabled_calculation.md b/tests/results/test/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..3bb5eb1 --- /dev/null +++ b/tests/results/test/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test/44_6leadership_follower_disabled_calculation.sh b/tests/results/test/44_6leadership_follower_disabled_calculation.sh new file mode 100644 index 0000000..b41a510 --- /dev/null +++ b/tests/results/test/44_6leadership_follower_disabled_calculation.sh @@ -0,0 +1,34 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + string standard mandatory A condition. + Default: yes + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic mandatory unique A leader. + multiple + leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/results/test/60_0family_dynamic.adoc b/tests/results/test/60_0family_dynamic.adoc new file mode 100644 index 0000000..17e36df --- /dev/null +++ b/tests/results/test/60_0family_dynamic.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_0family_dynamic.json b/tests/results/test/60_0family_dynamic.json new file mode 100644 index 0000000..3f7bf27 --- /dev/null +++ b/tests/results/test/60_0family_dynamic.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic.md b/tests/results/test/60_0family_dynamic.md new file mode 100644 index 0000000..b19f0f2 --- /dev/null +++ b/tests/results/test/60_0family_dynamic.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_0family_dynamic.sh b/tests/results/test/60_0family_dynamic.sh new file mode 100644 index 0000000..6120a4e --- /dev/null +++ b/tests/results/test/60_0family_dynamic.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/60_0family_dynamic_1_1.adoc b/tests/results/test/60_0family_dynamic_1_1.adoc new file mode 100644 index 0000000..5a17254 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.vardyn** + +**dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_0family_dynamic_1_1.json b/tests/results/test/60_0family_dynamic_1_1.json new file mode 100644 index 0000000..498d281 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["dynval1.vardyn", "dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_1_1.md b/tests/results/test/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..2c56936 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_0family_dynamic_1_1.sh b/tests/results/test/60_0family_dynamic_1_1.sh new file mode 100644 index 0000000..be01fb8 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.vardyn + dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/60_0family_dynamic_1_1_empty.adoc b/tests/results/test/60_0family_dynamic_1_1_empty.adoc new file mode 100644 index 0000000..ca494db --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1_empty.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.vardyn** + +**dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_0family_dynamic_1_1_empty.json b/tests/results/test/60_0family_dynamic_1_1_empty.json new file mode 100644 index 0000000..7830a06 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["dynval1.vardyn", "dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_1_1_empty.md b/tests/results/test/60_0family_dynamic_1_1_empty.md new file mode 100644 index 0000000..a65816e --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_0family_dynamic_1_1_empty.sh b/tests/results/test/60_0family_dynamic_1_1_empty.sh new file mode 100644 index 0000000..436f0ac --- /dev/null +++ b/tests/results/test/60_0family_dynamic_1_1_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.vardyn + dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/60_0family_dynamic_empty.adoc b/tests/results/test/60_0family_dynamic_empty.adoc new file mode 100644 index 0000000..d143594 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_empty.adoc @@ -0,0 +1,30 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_0family_dynamic_empty.json b/tests/results/test/60_0family_dynamic_empty.json new file mode 100644 index 0000000..99fd337 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynexample"], "names": ["dynexample"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynexample.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_empty.md b/tests/results/test/60_0family_dynamic_empty.md new file mode 100644 index 0000000..22f5904 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable. | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_0family_dynamic_empty.sh b/tests/results/test/60_0family_dynamic_empty.sh new file mode 100644 index 0000000..834fc63 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_empty.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A suffix variable. + + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynexample.var + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/60_0family_dynamic_no_description.adoc b/tests/results/test/60_0family_dynamic_no_description.adoc new file mode 100644 index 0000000..192048e --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + diff --git a/tests/results/test/60_0family_dynamic_no_description.json b/tests/results/test/60_0family_dynamic_no_description.json new file mode 100644 index 0000000..7757108 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_no_description.md b/tests/results/test/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..6cf2cb9 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/results/test/60_0family_dynamic_no_description.sh b/tests/results/test/60_0family_dynamic_no_description.sh new file mode 100644 index 0000000..649cefd --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory Var. + diff --git a/tests/results/test/60_0family_dynamic_no_description_empty.adoc b/tests/results/test/60_0family_dynamic_no_description_empty.adoc new file mode 100644 index 0000000..2357302 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description_empty.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + diff --git a/tests/results/test/60_0family_dynamic_no_description_empty.json b/tests/results/test/60_0family_dynamic_no_description_empty.json new file mode 100644 index 0000000..39f50ae --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_no_description_empty.md b/tests/results/test/60_0family_dynamic_no_description_empty.md new file mode 100644 index 0000000..7756f36 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/results/test/60_0family_dynamic_no_description_empty.sh b/tests/results/test/60_0family_dynamic_no_description_empty.sh new file mode 100644 index 0000000..a36ce96 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_no_description_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory Var. + diff --git a/tests/results/test/60_0family_dynamic_static.adoc b/tests/results/test/60_0family_dynamic_static.adoc new file mode 100644 index 0000000..0efe00e --- /dev/null +++ b/tests/results/test/60_0family_dynamic_static.adoc @@ -0,0 +1,24 @@ +== Variables + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: + +* val1 +* val2 + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable inside a dynamic family. +|==== + diff --git a/tests/results/test/60_0family_dynamic_static.json b/tests/results/test/60_0family_dynamic_static.json new file mode 100644 index 0000000..62b3d7f --- /dev/null +++ b/tests/results/test/60_0family_dynamic_static.json @@ -0,0 +1 @@ +{"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside a dynamic family."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_static.md b/tests/results/test/60_0family_dynamic_static.md new file mode 100644 index 0000000..aa090aa --- /dev/null +++ b/tests/results/test/60_0family_dynamic_static.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable inside a dynamic family. | + diff --git a/tests/results/test/60_0family_dynamic_static.sh b/tests/results/test/60_0family_dynamic_static.sh new file mode 100644 index 0000000..d2a3031 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_static.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A variable inside a dynamic family. + diff --git a/tests/results/test/60_0family_dynamic_test.adoc b/tests/results/test/60_0family_dynamic_test.adoc new file mode 100644 index 0000000..afe2f02 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_test.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_0family_dynamic_test.json b/tests/results/test/60_0family_dynamic_test.json new file mode 100644 index 0000000..d4bd2fa --- /dev/null +++ b/tests/results/test/60_0family_dynamic_test.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_test.md b/tests/results/test/60_0family_dynamic_test.md new file mode 100644 index 0000000..c28787d --- /dev/null +++ b/tests/results/test/60_0family_dynamic_test.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_0family_dynamic_test.sh b/tests/results/test/60_0family_dynamic_test.sh new file mode 100644 index 0000000..6140825 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_test.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory unique A suffix variable. + multiple + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/60_0family_dynamic_variable_empty.adoc b/tests/results/test/60_0family_dynamic_variable_empty.adoc new file mode 100644 index 0000000..d764691 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_empty.adoc @@ -0,0 +1,31 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: val +|==== + diff --git a/tests/results/test/60_0family_dynamic_variable_empty.json b/tests/results/test/60_0family_dynamic_variable_empty.json new file mode 100644 index 0000000..3cd5999 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynexample"], "names": ["dynexample"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynexample.var"], "names": ["var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_variable_empty.md b/tests/results/test/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..8e45674 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | + diff --git a/tests/results/test/60_0family_dynamic_variable_empty.sh b/tests/results/test/60_0family_dynamic_variable_empty.sh new file mode 100644 index 0000000..f6527fd --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_empty.sh @@ -0,0 +1,31 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory unique A suffix variable. + multiple + + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynexample.var + string standard mandatory A variable inside dynamic family. + Default: val + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix.adoc b/tests/results/test/60_0family_dynamic_variable_suffix.adoc new file mode 100644 index 0000000..8e6788f --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix.adoc @@ -0,0 +1,37 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable with suffix __val1__. + +A dynamic variable with suffix __val2__. + +**Default**: a value +|==== + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix.json b/tests/results/test/60_0family_dynamic_variable_suffix.json new file mode 100644 index 0000000..15cb1d8 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "a value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable with suffix val1.", "A dynamic variable with suffix val2."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_variable_suffix.md b/tests/results/test/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..38febd2 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix.sh b/tests/results/test/60_0family_dynamic_variable_suffix.sh new file mode 100644 index 0000000..64bde6c --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix_empty.adoc b/tests/results/test/60_0family_dynamic_variable_suffix_empty.adoc new file mode 100644 index 0000000..f8bfcc8 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix_empty.adoc @@ -0,0 +1,37 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable with suffix __val1__. + +A dynamic variable with suffix __val2__. + +**Default**: a value +|==== + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix_empty.json b/tests/results/test/60_0family_dynamic_variable_suffix_empty.json new file mode 100644 index 0000000..54d6604 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "a value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable with suffix val1.", "A dynamic variable with suffix val2."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_dynamic_variable_suffix_empty.md b/tests/results/test/60_0family_dynamic_variable_suffix_empty.md new file mode 100644 index 0000000..58f36fa --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + diff --git a/tests/results/test/60_0family_dynamic_variable_suffix_empty.sh b/tests/results/test/60_0family_dynamic_variable_suffix_empty.sh new file mode 100644 index 0000000..30f75d8 --- /dev/null +++ b/tests/results/test/60_0family_dynamic_variable_suffix_empty.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string basic mandatory unique A suffix variable. + multiple + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/results/test/60_0family_empty.adoc b/tests/results/test/60_0family_empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/60_0family_empty.json b/tests/results/test/60_0family_empty.json similarity index 100% rename from tests/docs/base/60_0family_empty.json rename to tests/results/test/60_0family_empty.json diff --git a/tests/results/test/60_0family_empty.md b/tests/results/test/60_0family_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/60_0family_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/60_0family_empty.sh b/tests/results/test/60_0family_empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/60_0family_hidden.adoc b/tests/results/test/60_0family_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/60_0family_hidden.json b/tests/results/test/60_0family_hidden.json similarity index 100% rename from tests/docs/base/60_0family_hidden.json rename to tests/results/test/60_0family_hidden.json diff --git a/tests/results/test/60_0family_hidden.md b/tests/results/test/60_0family_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test/60_0family_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test/60_0family_hidden.sh b/tests/results/test/60_0family_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test/60_0family_mode.adoc b/tests/results/test/60_0family_mode.adoc new file mode 100644 index 0000000..b1d6544 --- /dev/null +++ b/tests/results/test/60_0family_mode.adoc @@ -0,0 +1,17 @@ +== Variables + +=== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. + +**Default**: non +|==== + diff --git a/tests/results/test/60_0family_mode.json b/tests/results/test/60_0family_mode.json new file mode 100644 index 0000000..3394837 --- /dev/null +++ b/tests/results/test/60_0family_mode.json @@ -0,0 +1 @@ +{"family": {"type": "family", "informations": {"paths": ["family"], "names": ["family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "default": "non", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["family.var"], "names": ["var"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_0family_mode.md b/tests/results/test/60_0family_mode.md new file mode 100644 index 0000000..8634d6d --- /dev/null +++ b/tests/results/test/60_0family_mode.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | + diff --git a/tests/results/test/60_0family_mode.sh b/tests/results/test/60_0family_mode.sh new file mode 100644 index 0000000..ef8e380 --- /dev/null +++ b/tests/results/test/60_0family_mode.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + family.var + string basic mandatory A variable. + Default: non + diff --git a/tests/results/test/60_1family_dynamic_jinja.adoc b/tests/results/test/60_1family_dynamic_jinja.adoc new file mode 100644 index 0000000..b575902 --- /dev/null +++ b/tests/results/test/60_1family_dynamic_jinja.adoc @@ -0,0 +1,36 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: index of suffix value. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__1__.var** + +**dyn__2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + diff --git a/tests/results/test/60_1family_dynamic_jinja.json b/tests/results/test/60_1family_dynamic_jinja.json new file mode 100644 index 0000000..a53308f --- /dev/null +++ b/tests/results/test/60_1family_dynamic_jinja.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dyn1", "dyn2"], "names": ["dyn1", "dyn2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "index of suffix value.", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dyn1.var", "dyn2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_1family_dynamic_jinja.md b/tests/results/test/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..97d4612 --- /dev/null +++ b/tests/results/test/60_1family_dynamic_jinja.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: index of suffix value. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*1*.var**
**dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + diff --git a/tests/results/test/60_1family_dynamic_jinja.sh b/tests/results/test/60_1family_dynamic_jinja.sh new file mode 100644 index 0000000..48b7905 --- /dev/null +++ b/tests/results/test/60_1family_dynamic_jinja.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: index of suffix value. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dyn1.var + dyn2.var + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.adoc new file mode 100644 index 0000000..4f80a38 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -0,0 +1,50 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +==== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.json b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.json new file mode 100644 index 0000000..380dd5b --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["With a variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.md b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..a6bfdb0 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +### a family + +`basic` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.sh b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.sh new file mode 100644 index 0000000..d4cfc63 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + a family + +basic + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.adoc new file mode 100644 index 0000000..de2c1c9 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -0,0 +1,51 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A identifier variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +==== a family inside dynamic family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A varible outside dynamic family. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.json b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.json new file mode 100644 index 0000000..e8810c4 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family inside dynamic family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A varible outside dynamic family."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..8a5d011 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the 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. | + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.sh b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.sh new file mode 100644 index 0000000..abb37ce --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2.sh @@ -0,0 +1,54 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a family inside dynamic family + +standard + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc new file mode 100644 index 0000000..0d20541 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc @@ -0,0 +1,51 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A identifier variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +==== a family inside dynamic family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A varible outside dynamic family. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.json b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.json new file mode 100644 index 0000000..de0c972 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family inside dynamic family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A varible outside dynamic family."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.md b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.md new file mode 100644 index 0000000..451a8e5 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A varible outside dynamic family.
**Default**: the value of var. | + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh new file mode 100644 index 0000000..5b6501f --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A identifier variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a family inside dynamic family + +standard + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.adoc b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.adoc new file mode 100644 index 0000000..a7b6213 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.adoc @@ -0,0 +1,50 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +==== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.json b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.json new file mode 100644 index 0000000..1f33d61 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["With a variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.md b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.md new file mode 100644 index 0000000..ca81cc7 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +### a family + +`basic` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + diff --git a/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.sh b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.sh new file mode 100644 index 0000000..b643027 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_jinja_fill_sub_group_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + a family + +basic + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard A second variable. + Default: the value of var. + diff --git a/tests/results/test/60_2family_dynamic_outside_calc.adoc b/tests/results/test/60_2family_dynamic_outside_calc.adoc new file mode 100644 index 0000000..fdd8db8 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc.adoc @@ -0,0 +1,47 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffx variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**newvar** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_outside_calc.json b/tests/results/test/60_2family_dynamic_outside_calc.json new file mode 100644 index 0000000..ee63090 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffx variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "newvar": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["newvar"], "names": ["newvar"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_outside_calc.md b/tests/results/test/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..75bf819 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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. | + diff --git a/tests/results/test/60_2family_dynamic_outside_calc.sh b/tests/results/test/60_2family_dynamic_outside_calc.sh new file mode 100644 index 0000000..662bbf0 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc.sh @@ -0,0 +1,49 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A suffx variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + newvar + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/results/test/60_2family_dynamic_outside_calc_empty.adoc b/tests/results/test/60_2family_dynamic_outside_calc_empty.adoc new file mode 100644 index 0000000..2562b65 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc_empty.adoc @@ -0,0 +1,47 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffx variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**newvar** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test/60_2family_dynamic_outside_calc_empty.json b/tests/results/test/60_2family_dynamic_outside_calc_empty.json new file mode 100644 index 0000000..367e004 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc_empty.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffx variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "newvar": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["newvar"], "names": ["newvar"], "descriptions": ["A second variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_2family_dynamic_outside_calc_empty.md b/tests/results/test/60_2family_dynamic_outside_calc_empty.md new file mode 100644 index 0000000..47671f0 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffx variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + diff --git a/tests/results/test/60_2family_dynamic_outside_calc_empty.sh b/tests/results/test/60_2family_dynamic_outside_calc_empty.sh new file mode 100644 index 0000000..49122f6 --- /dev/null +++ b/tests/results/test/60_2family_dynamic_outside_calc_empty.sh @@ -0,0 +1,48 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard unique multiple A suffx variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + newvar + string standard A second variable. + Default: the value of var. + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2.adoc b/tests/results/test/60_5family_dynamic_calc_suffix2.adoc new file mode 100644 index 0000000..e30b6bf --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2.adoc @@ -0,0 +1,36 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix has value. + +**Default**: the value of the identifier. +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2.json b/tests/results/test/60_5family_dynamic_calc_suffix2.json new file mode 100644 index 0000000..ab8947b --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Suffix has value."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2.md b/tests/results/test/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..62d2fd7 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2.sh b/tests/results/test/60_5family_dynamic_calc_suffix2.sh new file mode 100644 index 0000000..aaba8ba --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory Suffix has value. + Default: the value of the + identifier. + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2_empty.adoc b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.adoc new file mode 100644 index 0000000..be0fbef --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.adoc @@ -0,0 +1,36 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix has value. + +**Default**: the value of the identifier. +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2_empty.json b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.json new file mode 100644 index 0000000..d1c44b8 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Suffix has value."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2_empty.md b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.md new file mode 100644 index 0000000..fdb5d99 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix2_empty.sh b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.sh new file mode 100644 index 0000000..84d5233 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix2_empty.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory Suffix has value. + Default: the value of the + identifier. + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param.adoc b/tests/results/test/60_5family_dynamic_calc_suffix_param.adoc new file mode 100644 index 0000000..08790f6 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param.adoc @@ -0,0 +1,36 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A identifier variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: from suffix. +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param.json b/tests/results/test/60_5family_dynamic_calc_suffix_param.json new file mode 100644 index 0000000..e505563 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "from suffix.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param.md b/tests/results/test/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..2673a2c --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param.sh b/tests/results/test/60_5family_dynamic_calc_suffix_param.sh new file mode 100644 index 0000000..30d4cb2 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.adoc b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.adoc new file mode 100644 index 0000000..cc79650 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.adoc @@ -0,0 +1,36 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A identifier variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: from suffix. +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.json b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.json new file mode 100644 index 0000000..500c18e --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "from suffix.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.md b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.md new file mode 100644 index 0000000..9ca8013 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + diff --git a/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.sh b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.sh new file mode 100644 index 0000000..36bbabf --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_suffix_param_empty.sh @@ -0,0 +1,38 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A identifier variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/results/test/60_5family_dynamic_calc_variable.adoc b/tests/results/test/60_5family_dynamic_calc_variable.adoc new file mode 100644 index 0000000..0f87f4a --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable.adoc @@ -0,0 +1,46 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== dyn__val1__ or dyn__val2__ + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: the value of the variable "dynval1.var". +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_variable.json b/tests/results/test/60_5family_dynamic_calc_variable.json new file mode 100644 index 0000000..f45aa35 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"dynval1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_variable.md b/tests/results/test/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..544f734 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## dyn*val1* or dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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". | + diff --git a/tests/results/test/60_5family_dynamic_calc_variable.sh b/tests/results/test/60_5family_dynamic_calc_variable.sh new file mode 100644 index 0000000..c9caeb2 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable.sh @@ -0,0 +1,48 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + dynval1 or dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A variable calculated. + Default: the value of the variable + "dynval1.var". + diff --git a/tests/results/test/60_5family_dynamic_calc_variable_empty.adoc b/tests/results/test/60_5family_dynamic_calc_variable_empty.adoc new file mode 100644 index 0000000..a901a74 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable_empty.adoc @@ -0,0 +1,49 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== dyn__val1__ or dyn__val2__ + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: + +* the value of the variable "dyn__val1__.var" +* the value of the variable "dyn__val2__.var" +|==== + diff --git a/tests/results/test/60_5family_dynamic_calc_variable_empty.json b/tests/results/test/60_5family_dynamic_calc_variable_empty.json new file mode 100644 index 0000000..d950f2e --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable_empty.json @@ -0,0 +1 @@ +{"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"dynval1.var\"", "the value of the variable \"dynval2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_calc_variable_empty.md b/tests/results/test/60_5family_dynamic_calc_variable_empty.md new file mode 100644 index 0000000..af1967a --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## dyn*val1* or dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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 "dyn*val1*.var"
- the value of the variable "dyn*val2*.var" | + diff --git a/tests/results/test/60_5family_dynamic_calc_variable_empty.sh b/tests/results/test/60_5family_dynamic_calc_variable_empty.sh new file mode 100644 index 0000000..7ee1d63 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_calc_variable_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var1 + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + dynval1 or dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A variable calculated. + Default: + + + • the value of the variable "dynval1.var" + • the value of the variable "dynval2.var" + | diff --git a/tests/results/test/60_5family_dynamic_hidden_suffix.adoc b/tests/results/test/60_5family_dynamic_hidden_suffix.adoc new file mode 100644 index 0000000..ba5401d --- /dev/null +++ b/tests/results/test/60_5family_dynamic_hidden_suffix.adoc @@ -0,0 +1,42 @@ +== Variables + +=== a dynamic family + +`standard` `__hidden__` + + +**Hidden**: if suffix == 'val2'. + +This family builds families dynamically. + +**Identifiers**: + +* val1 +* val2 + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.var** + +**dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. +|==== + +==== a family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.family.var** + +**dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A new variable. +|==== + diff --git a/tests/results/test/60_5family_dynamic_hidden_suffix.json b/tests/results/test/60_5family_dynamic_hidden_suffix.json new file mode 100644 index 0000000..3f4c0f1 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_hidden_suffix.json @@ -0,0 +1 @@ +{"dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if suffix == 'val2'."}], "identifiers": ["val1", "val2"], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dynval1.var", "dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable."]}, "family": {"type": "family", "informations": {"paths": ["dynval1.family", "dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["dynval1.family.var", "dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A new variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_hidden_suffix.md b/tests/results/test/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..0763e5e --- /dev/null +++ b/tests/results/test/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a dynamic family + +`standard` *`hidden`* + +**Hidden**: if suffix == 'val2'. + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + +### a family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | + diff --git a/tests/results/test/60_5family_dynamic_hidden_suffix.sh b/tests/results/test/60_5family_dynamic_hidden_suffix.sh new file mode 100644 index 0000000..9b23e8a --- /dev/null +++ b/tests/results/test/60_5family_dynamic_hidden_suffix.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +standard hidden + +Hidden: if suffix == 'val2'. + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable               Description           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.var + dynval2.var + string standard A variable. + + + a family + +standard + + + + +  Variable                    Description                + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.family.var + dynval2.family.var + string standard A new variable. + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix.adoc b/tests/results/test/60_5family_dynamic_variable_outside_suffix.adoc new file mode 100644 index 0000000..b4252ff --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix.adoc @@ -0,0 +1,47 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn___val1__.var** + +**dyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: the value of the variable "dyn_val1.var". +|==== + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix.json b/tests/results/test/60_5family_dynamic_variable_outside_suffix.json new file mode 100644 index 0000000..f9ca654 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dyn_val1", "dyn_val2"], "names": ["dyn_val1", "dyn_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dyn_val1.var", "dyn_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": "the value of the variable \"dyn_val1.var\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix.md b/tests/results/test/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..ce31013 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_*val1*.var**
**dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the 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". | + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix.sh b/tests/results/test/60_5family_dynamic_variable_outside_suffix.sh new file mode 100644 index 0000000..08ea095 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dyn_val1.var + dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard mandatory A variable. + Default: the value of the variable + "dyn_val1.var". + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.adoc b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.adoc new file mode 100644 index 0000000..8cd0088 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.adoc @@ -0,0 +1,50 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +Asuffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn___val1__.var** + +**dyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. + +**Default**: + +* the value of the variable "dyn___val1__.var" +* the value of the variable "dyn___val2__.var" +|==== + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.json b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.json new file mode 100644 index 0000000..05a79eb --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["Asuffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dyn_val1", "dyn_val2"], "names": ["dyn_val1", "dyn_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["dyn_val1.var", "dyn_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"dyn_val1.var\"", "the value of the variable \"dyn_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["var2"], "names": ["var2"], "descriptions": ["A variable."]}} \ No newline at end of file diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.md b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.md new file mode 100644 index 0000000..13b1cf6 --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Asuffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_*val1*.var**
**dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**:
- the value of the variable "dyn_*val1*.var"
- the value of the variable "dyn_*val2*.var" | + diff --git a/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.sh b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.sh new file mode 100644 index 0000000..685524a --- /dev/null +++ b/tests/results/test/60_5family_dynamic_variable_outside_suffix_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple Asuffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dyn_val1.var + dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var2 + string standard A variable. + Default: + + + • the value of the variable "dyn_val1.var" + • the value of the variable "dyn_val2.var" + | diff --git a/tests/results/test/60_6family_dynamic_leadership.adoc b/tests/results/test/60_6family_dynamic_leadership.adoc new file mode 100644 index 0000000..b1ae9fa --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership.adoc @@ -0,0 +1,53 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A suffix variable. + +**Default**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +==== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.leadership.leader** + +**dyn__val2__.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**dyn__val1__.leadership.follower1** + +**dyn__val2__.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| + +**dyn__val1__.leadership.follower2** + +**dyn__val2__.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. +|==== + diff --git a/tests/results/test/60_6family_dynamic_leadership.json b/tests/results/test/60_6family_dynamic_leadership.json new file mode 100644 index 0000000..29b2687 --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["dynval1.leadership", "dynval2.leadership"], "names": ["leadership", "leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"paths": ["dynval1.leadership.leader", "dynval2.leadership.leader"], "names": ["leader", "leader"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A leader."], "multiple": true}, "follower1": {"paths": ["dynval1.leadership.follower1", "dynval2.leadership.follower1"], "names": ["follower1", "follower1"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower1."]}, "follower2": {"paths": ["dynval1.leadership.follower2", "dynval2.leadership.follower2"], "names": ["follower2", "follower2"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower2."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/60_6family_dynamic_leadership.md b/tests/results/test/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..d96629b --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.leadership.leader**
**dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dyn*val1*.leadership.follower1**
**dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dyn*val1*.leadership.follower2**
**dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + diff --git a/tests/results/test/60_6family_dynamic_leadership.sh b/tests/results/test/60_6family_dynamic_leadership.sh new file mode 100644 index 0000000..7f343de --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership.sh @@ -0,0 +1,54 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.leadership.leader + dynval2.leadership.leader + string basic mandatory unique A leader. + multiple + dynval1.leadership.follower1 + dynval2.leadership.follower1 + string standard A follower1. + dynval1.leadership.follower2 + dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/results/test/60_6family_dynamic_leadership_empty.adoc b/tests/results/test/60_6family_dynamic_leadership_empty.adoc new file mode 100644 index 0000000..d8999bd --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership_empty.adoc @@ -0,0 +1,53 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +==== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.leadership.leader** + +**dyn__val2__.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**dyn__val1__.leadership.follower1** + +**dyn__val2__.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| + +**dyn__val1__.leadership.follower2** + +**dyn__val2__.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. +|==== + diff --git a/tests/results/test/60_6family_dynamic_leadership_empty.json b/tests/results/test/60_6family_dynamic_leadership_empty.json new file mode 100644 index 0000000..b55779a --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership_empty.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"var\".", "help": ["This family builds families dynamically."]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["dynval1.leadership", "dynval2.leadership"], "names": ["leadership", "leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"paths": ["dynval1.leadership.leader", "dynval2.leadership.leader"], "names": ["leader", "leader"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A leader."], "multiple": true}, "follower1": {"paths": ["dynval1.leadership.follower1", "dynval2.leadership.follower1"], "names": ["follower1", "follower1"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower1."]}, "follower2": {"paths": ["dynval1.leadership.follower2", "dynval2.leadership.follower2"], "names": ["follower2", "follower2"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower2."]}}}}}} \ No newline at end of file diff --git a/tests/results/test/60_6family_dynamic_leadership_empty.md b/tests/results/test/60_6family_dynamic_leadership_empty.md new file mode 100644 index 0000000..b85291f --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.leadership.leader**
**dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dyn*val1*.leadership.follower1**
**dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dyn*val1*.leadership.follower2**
**dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + diff --git a/tests/results/test/60_6family_dynamic_leadership_empty.sh b/tests/results/test/60_6family_dynamic_leadership_empty.sh new file mode 100644 index 0000000..b42c593 --- /dev/null +++ b/tests/results/test/60_6family_dynamic_leadership_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.leadership.leader + dynval2.leadership.leader + string basic mandatory unique A leader. + multiple + dynval1.leadership.follower1 + dynval2.leadership.follower1 + string standard A follower1. + dynval1.leadership.follower2 + dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/results/test/60_9family_dynamic_calc_both.adoc b/tests/results/test/60_9family_dynamic_calc_both.adoc new file mode 100644 index 0000000..6c2b9ec --- /dev/null +++ b/tests/results/test/60_9family_dynamic_calc_both.adoc @@ -0,0 +1,35 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A suffix variable. + +**Default**: val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: + +* val1 +* the value of the variable "var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**dyn__val1__.vardyn** + +**dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test/60_9family_dynamic_calc_both.json b/tests/results/test/60_9family_dynamic_calc_both.json new file mode 100644 index 0000000..5d2d41f --- /dev/null +++ b/tests/results/test/60_9family_dynamic_calc_both.json @@ -0,0 +1 @@ +{"var": {"type": "variable", "default": "val2", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["var"], "names": ["var"], "descriptions": ["A suffix variable."]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["dynval1", "dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": ["val1", "the value of the variable \"var\"."], "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["dynval1.vardyn", "dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}} \ No newline at end of file diff --git a/tests/results/test/60_9family_dynamic_calc_both.md b/tests/results/test/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..1f55999 --- /dev/null +++ b/tests/results/test/60_9family_dynamic_calc_both.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test/60_9family_dynamic_calc_both.sh b/tests/results/test/60_9family_dynamic_calc_both.sh new file mode 100644 index 0000000..eebe11e --- /dev/null +++ b/tests/results/test/60_9family_dynamic_calc_both.sh @@ -0,0 +1,35 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + var + string standard mandatory A suffix variable. + Default: val2 + + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • the value of the variable "var". + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + dynval1.vardyn + dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/results/test/68_0family_leadership_mode.adoc b/tests/results/test/68_0family_leadership_mode.adoc new file mode 100644 index 0000000..5b4b9ba --- /dev/null +++ b/tests/results/test/68_0family_leadership_mode.adoc @@ -0,0 +1,28 @@ +== Variables + +=== A leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**leader.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. +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A follower2. +|==== + diff --git a/tests/results/test/68_0family_leadership_mode.json b/tests/results/test/68_0family_leadership_mode.json new file mode 100644 index 0000000..8491c6f --- /dev/null +++ b/tests/results/test/68_0family_leadership_mode.json @@ -0,0 +1 @@ +{"leader": {"type": "leadership", "informations": {"paths": ["leader"], "names": ["leader"], "description": "A leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["leader.follower1"], "names": ["follower1"], "descriptions": ["A follower1."]}, "follower2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["A follower2."]}}}} \ No newline at end of file diff --git a/tests/results/test/68_0family_leadership_mode.md b/tests/results/test/68_0family_leadership_mode.md new file mode 100644 index 0000000..55b3c35 --- /dev/null +++ b/tests/results/test/68_0family_leadership_mode.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A leadership + +`basic` + +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. | + diff --git a/tests/results/test/68_0family_leadership_mode.sh b/tests/results/test/68_0family_leadership_mode.sh new file mode 100644 index 0000000..0a727fe --- /dev/null +++ b/tests/results/test/68_0family_leadership_mode.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string basic unique multiple A leader. + leader.follower1 + string standard A follower1. + leader.follower2 + string basic mandatory A follower2. + diff --git a/tests/results/test_examples/00_0empty.md b/tests/results/test_examples/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/00_0version_underscore.md b/tests/results/test_examples/00_0version_underscore.md new file mode 100644 index 0000000..2e3b5c8 --- /dev/null +++ b/tests/results/test_examples/00_0version_underscore.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +version: example +``` +# Example with all variables modifiable + +```yaml +--- +version: example +``` diff --git a/tests/results/test_examples/00_1empty_variable.md b/tests/results/test_examples/00_1empty_variable.md new file mode 100644 index 0000000..8621f91 --- /dev/null +++ b/tests/results/test_examples/00_1empty_variable.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Empty. | + +# Example with mandatory variables not filled in + +```yaml +--- +empty: example +``` +# Example with all variables modifiable + +```yaml +--- +empty: example +``` diff --git a/tests/results/test_examples/00_2default_calculated.md b/tests/results/test_examples/00_2default_calculated.md new file mode 100644 index 0000000..21b032e --- /dev/null +++ b/tests/results/test_examples/00_2default_calculated.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: + - no +``` diff --git a/tests/results/test_examples/00_2default_calculated_multi.md b/tests/results/test_examples/00_2default_calculated_multi.md new file mode 100644 index 0000000..3492bb2 --- /dev/null +++ b/tests/results/test_examples/00_2default_calculated_multi.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with all variables modifiable + +```yaml +--- +var1: + - no + - yes + - maybe +var2: + - no + - yes + - maybe +``` diff --git a/tests/results/test_examples/00_2default_calculated_variable_transitive.md b/tests/results/test_examples/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..fb4615e --- /dev/null +++ b/tests/results/test_examples/00_2default_calculated_variable_transitive.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                           | Description                                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | +| **var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "var1". | + +# Example with mandatory variables not filled in + +```yaml +--- +var1: + - example.net +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - example.net +var2: + - example.net +``` diff --git a/tests/results/test_examples/00_4load_subfolder.md b/tests/results/test_examples/00_4load_subfolder.md new file mode 100644 index 0000000..f842ac7 --- /dev/null +++ b/tests/results/test_examples/00_4load_subfolder.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# 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/results/test_examples/00_5load_notype.md b/tests/results/test_examples/00_5load_notype.md new file mode 100644 index 0000000..9f3577f --- /dev/null +++ b/tests/results/test_examples/00_5load_notype.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +without_type: non +``` diff --git a/tests/results/test_examples/00_6boolean.md b/tests/results/test_examples/00_6boolean.md new file mode 100644 index 0000000..70dfeb2 --- /dev/null +++ b/tests/results/test_examples/00_6boolean.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var1: true +var2: true +var3: true +var4: false +var5: false +var6: false +``` diff --git a/tests/results/test_examples/00_6boolean_no_mandatory.md b/tests/results/test_examples/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..ddd7374 --- /dev/null +++ b/tests/results/test_examples/00_6boolean_no_mandatory.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | + +# Example with all variables modifiable + +```yaml +--- +variable: true +``` diff --git a/tests/results/test_examples/00_6choice.md b/tests/results/test_examples/00_6choice.md new file mode 100644 index 0000000..a0f85a4 --- /dev/null +++ b/tests/results/test_examples/00_6choice.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/00_6choice_calculation.md b/tests/results/test_examples/00_6choice_calculation.md new file mode 100644 index 0000000..d59f66f --- /dev/null +++ b/tests/results/test_examples/00_6choice_calculation.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var: 9 +``` diff --git a/tests/results/test_examples/00_6choice_variable.md b/tests/results/test_examples/00_6choice_variable.md new file mode 100644 index 0000000..5ce8391 --- /dev/null +++ b/tests/results/test_examples/00_6choice_variable.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var1: + - a + - b + - c +var2: a +``` diff --git a/tests/results/test_examples/00_6custom.md b/tests/results/test_examples/00_6custom.md new file mode 100644 index 0000000..6204f48 --- /dev/null +++ b/tests/results/test_examples/00_6custom.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with mandatory variables not filled in + +```yaml +--- +custom1: xxx +``` +# Example with all variables modifiable + +```yaml +--- +custom1: xxx +custom2: value +``` diff --git a/tests/results/test_examples/00_6domainname.md b/tests/results/test_examples/00_6domainname.md new file mode 100644 index 0000000..3f71d1b --- /dev/null +++ b/tests/results/test_examples/00_6domainname.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +variable: my.domain.name +``` diff --git a/tests/results/test_examples/00_6domainname_params.md b/tests/results/test_examples/00_6domainname_params.md new file mode 100644 index 0000000..31cf0e4 --- /dev/null +++ b/tests/results/test_examples/00_6domainname_params.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +variable: my.domain.name +``` diff --git a/tests/results/test_examples/00_6float.md b/tests/results/test_examples/00_6float.md new file mode 100644 index 0000000..d08f9d8 --- /dev/null +++ b/tests/results/test_examples/00_6float.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/00_6number.md b/tests/results/test_examples/00_6number.md new file mode 100644 index 0000000..fc1e119 --- /dev/null +++ b/tests/results/test_examples/00_6number.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var1: 0 +var2: 0 +var3: 0 +var4: 10 +var5: 10 +var6: 10 +``` diff --git a/tests/results/test_examples/00_6port.md b/tests/results/test_examples/00_6port.md new file mode 100644 index 0000000..42ff443 --- /dev/null +++ b/tests/results/test_examples/00_6port.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable. | +| **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | +| **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | + +# Example with mandatory variables not filled in + +```yaml +--- +variable1: '111' +``` +# Example with all variables modifiable + +```yaml +--- +variable1: '111' +variable2: '8080' +variable3: '8080' +``` diff --git a/tests/results/test_examples/00_6regexp.md b/tests/results/test_examples/00_6regexp.md new file mode 100644 index 0000000..197f05c --- /dev/null +++ b/tests/results/test_examples/00_6regexp.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | + +# Example with all variables modifiable + +```yaml +--- +var: '#b1b1b1' +``` diff --git a/tests/results/test_examples/00_6string.md b/tests/results/test_examples/00_6string.md new file mode 100644 index 0000000..c343a51 --- /dev/null +++ b/tests/results/test_examples/00_6string.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/00_7choice_quote.md b/tests/results/test_examples/00_7choice_quote.md new file mode 100644 index 0000000..91fc514 --- /dev/null +++ b/tests/results/test_examples/00_7choice_quote.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | + +# Example with all variables modifiable + +```yaml +--- +var: quote' +``` diff --git a/tests/results/test_examples/00_7help_quote.md b/tests/results/test_examples/00_7help_quote.md new file mode 100644 index 0000000..84a6451 --- /dev/null +++ b/tests/results/test_examples/00_7help_quote.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# 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 ". | + +# 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/results/test_examples/00_7value_doublequote.md b/tests/results/test_examples/00_7value_doublequote.md new file mode 100644 index 0000000..792171b --- /dev/null +++ b/tests/results/test_examples/00_7value_doublequote.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | + +# Example with all variables modifiable + +```yaml +--- +variable: quote" +``` diff --git a/tests/results/test_examples/00_7value_doublequote2.md b/tests/results/test_examples/00_7value_doublequote2.md new file mode 100644 index 0000000..0a17224 --- /dev/null +++ b/tests/results/test_examples/00_7value_doublequote2.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | + +# Example with all variables modifiable + +```yaml +--- +variable: quote'" +``` diff --git a/tests/results/test_examples/00_7value_doublequote3.md b/tests/results/test_examples/00_7value_doublequote3.md new file mode 100644 index 0000000..9554574 --- /dev/null +++ b/tests/results/test_examples/00_7value_doublequote3.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | + +# Example with all variables modifiable + +```yaml +--- +variable: quote\"\' +``` diff --git a/tests/results/test_examples/00_7value_quote.md b/tests/results/test_examples/00_7value_quote.md new file mode 100644 index 0000000..25665d3 --- /dev/null +++ b/tests/results/test_examples/00_7value_quote.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | + +# Example with all variables modifiable + +```yaml +--- +variable: quote' +``` diff --git a/tests/results/test_examples/00_8calculation_information.md b/tests/results/test_examples/00_8calculation_information.md new file mode 100644 index 0000000..e0a6a5b --- /dev/null +++ b/tests/results/test_examples/00_8calculation_information.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: get information test_information. | + +# Example with all variables modifiable + +```yaml +--- +variable: example +``` diff --git a/tests/results/test_examples/00_8test.md b/tests/results/test_examples/00_8test.md new file mode 100644 index 0000000..6fce12f --- /dev/null +++ b/tests/results/test_examples/00_8test.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# 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.
**Examples**:
- test1
- test2 | +| **var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Examples**:
- null
- test1
- test2 | +| **var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | +| **var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | + +# Example with mandatory variables not filled in + +```yaml +--- +var1: test +var3: test1 +var6: + - test1 + - test2 +``` +# Example with all variables modifiable + +```yaml +--- +var1: test +var2: test +var3: test1 +var4: +var5: false +var6: + - test1 + - test2 +``` diff --git a/tests/results/test_examples/00_9choice_variable_multi.md b/tests/results/test_examples/00_9choice_variable_multi.md new file mode 100644 index 0000000..fe04859 --- /dev/null +++ b/tests/results/test_examples/00_9choice_variable_multi.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| 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 | + +# 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/results/test_examples/00_9choice_variables.md b/tests/results/test_examples/00_9choice_variables.md new file mode 100644 index 0000000..be9666c --- /dev/null +++ b/tests/results/test_examples/00_9choice_variables.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **source_variable_1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The first source variable.
**Default**: val1 | +| **source_variable_2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second source variable.
**Default**: val2 | +| **my_variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**:
- the value of the variable "source_variable_1".
- the value of the variable "source_variable_2".
**Default**: val1 | + +# Example with all variables modifiable + +```yaml +--- +source_variable_1: val1 +source_variable_2: val2 +my_variable: val1 +``` diff --git a/tests/results/test_examples/00_9default_calculation.md b/tests/results/test_examples/00_9default_calculation.md new file mode 100644 index 0000000..059a2c8 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | + +# Example with all variables modifiable + +```yaml +--- +variable: string_1_True_None +``` diff --git a/tests/results/test_examples/00_9default_calculation_information.md b/tests/results/test_examples/00_9default_calculation_information.md new file mode 100644 index 0000000..7c14fd1 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_information.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | + +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/results/test_examples/00_9default_calculation_information_other_variable.md b/tests/results/test_examples/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..968f91a --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_information_other_variable.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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**: depends on a calculation. | + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/results/test_examples/00_9default_calculation_multi_optional.md b/tests/results/test_examples/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..e69f386 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_multi_optional.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + +# Example with all variables modifiable + +```yaml +--- +my_variable: val1 +my_calculated_variable: + - val1 +``` diff --git a/tests/results/test_examples/00_9default_calculation_multi_optional2.md b/tests/results/test_examples/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..e69f386 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_multi_optional2.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + +# Example with all variables modifiable + +```yaml +--- +my_variable: val1 +my_calculated_variable: + - val1 +``` diff --git a/tests/results/test_examples/00_9default_calculation_optional.md b/tests/results/test_examples/00_9default_calculation_optional.md new file mode 100644 index 0000000..22a1362 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_optional.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +my_calculated_variable: + - example +``` +# Example with all variables modifiable + +```yaml +--- +my_calculated_variable: + - example +``` diff --git a/tests/results/test_examples/00_9default_calculation_optional_exists.md b/tests/results/test_examples/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..8e5c7e8 --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_optional_exists.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | +| **my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "my_variable". | + +# Example with all variables modifiable + +```yaml +--- +my_variable: + - val1 + - val2 +my_calculated_variable: + - val1 + - val2 +``` diff --git a/tests/results/test_examples/00_9default_calculation_param_optional.md b/tests/results/test_examples/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..163dada --- /dev/null +++ b/tests/results/test_examples/00_9default_calculation_param_optional.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: no +``` diff --git a/tests/results/test_examples/00_9default_information_other_variable.md b/tests/results/test_examples/00_9default_information_other_variable.md new file mode 100644 index 0000000..d9e6e9d --- /dev/null +++ b/tests/results/test_examples/00_9default_information_other_variable.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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**: the value of the information "test_information" of the variable "var1". | + +# Example with mandatory variables not filled in + +```yaml +--- +var1: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: example +var2: example +``` diff --git a/tests/results/test_examples/00_9default_integer.md b/tests/results/test_examples/00_9default_integer.md new file mode 100644 index 0000000..ea64e5b --- /dev/null +++ b/tests/results/test_examples/00_9default_integer.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var: 9 +``` diff --git a/tests/results/test_examples/01_6boolean_multi.md b/tests/results/test_examples/01_6boolean_multi.md new file mode 100644 index 0000000..4e17a42 --- /dev/null +++ b/tests/results/test_examples/01_6boolean_multi.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/01_6custom_multi.md b/tests/results/test_examples/01_6custom_multi.md new file mode 100644 index 0000000..9f2aaed --- /dev/null +++ b/tests/results/test_examples/01_6custom_multi.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with mandatory variables not filled in + +```yaml +--- +custom1: + - xxx +``` +# Example with all variables modifiable + +```yaml +--- +custom1: + - xxx +custom2: + - value +``` diff --git a/tests/results/test_examples/01_6float_multi.md b/tests/results/test_examples/01_6float_multi.md new file mode 100644 index 0000000..0153082 --- /dev/null +++ b/tests/results/test_examples/01_6float_multi.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/01_6number_multi.md b/tests/results/test_examples/01_6number_multi.md new file mode 100644 index 0000000..393b5d0 --- /dev/null +++ b/tests/results/test_examples/01_6number_multi.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/01_6string_empty.md b/tests/results/test_examples/01_6string_empty.md new file mode 100644 index 0000000..2c9af20 --- /dev/null +++ b/tests/results/test_examples/01_6string_empty.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | + +# Example with all variables modifiable + +```yaml +--- +var1: + - value + - +``` diff --git a/tests/results/test_examples/01_6string_multi.md b/tests/results/test_examples/01_6string_multi.md new file mode 100644 index 0000000..d9c3a28 --- /dev/null +++ b/tests/results/test_examples/01_6string_multi.md @@ -0,0 +1,47 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# 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/results/test_examples/01_7value_multi_doublequote.md b/tests/results/test_examples/01_7value_multi_doublequote.md new file mode 100644 index 0000000..2efce49 --- /dev/null +++ b/tests/results/test_examples/01_7value_multi_doublequote.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote" +``` diff --git a/tests/results/test_examples/01_7value_multi_doublequote2.md b/tests/results/test_examples/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..72f911a --- /dev/null +++ b/tests/results/test_examples/01_7value_multi_doublequote2.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote'" +``` diff --git a/tests/results/test_examples/01_7value_multi_quote.md b/tests/results/test_examples/01_7value_multi_quote.md new file mode 100644 index 0000000..b3c9694 --- /dev/null +++ b/tests/results/test_examples/01_7value_multi_quote.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | + +# Example with all variables modifiable + +```yaml +--- +variable: + - quote' +``` diff --git a/tests/results/test_examples/01_8calculation_information_multi.md b/tests/results/test_examples/01_8calculation_information_multi.md new file mode 100644 index 0000000..8ffb691 --- /dev/null +++ b/tests/results/test_examples/01_8calculation_information_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with all variables modifiable + +```yaml +--- +variable: + - example +``` diff --git a/tests/results/test_examples/01_9choice_variable_multi.md b/tests/results/test_examples/01_9choice_variable_multi.md new file mode 100644 index 0000000..ed3c655 --- /dev/null +++ b/tests/results/test_examples/01_9choice_variable_multi.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# 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/results/test_examples/04_0type_param.md b/tests/results/test_examples/04_0type_param.md new file mode 100644 index 0000000..a4a32fd --- /dev/null +++ b/tests/results/test_examples/04_0type_param.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | + +# Example with all variables modifiable + +```yaml +--- +int: 10 +``` diff --git a/tests/results/test_examples/04_1auto_save.md b/tests/results/test_examples/04_1auto_save.md new file mode 100644 index 0000000..375e9c2 --- /dev/null +++ b/tests/results/test_examples/04_1auto_save.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +variable: no +``` diff --git a/tests/results/test_examples/04_1auto_save_and_calculated.md b/tests/results/test_examples/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..dc76d3e --- /dev/null +++ b/tests/results/test_examples/04_1auto_save_and_calculated.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: no +``` diff --git a/tests/results/test_examples/04_1auto_save_and_calculated_hidden.md b/tests/results/test_examples/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..3616e33 --- /dev/null +++ b/tests/results/test_examples/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: yes +``` diff --git a/tests/results/test_examples/04_1auto_save_and_hidden.md b/tests/results/test_examples/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/04_1auto_save_and_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/04_1default_calculation_hidden.md b/tests/results/test_examples/04_1default_calculation_hidden.md new file mode 100644 index 0000000..5695a33 --- /dev/null +++ b/tests/results/test_examples/04_1default_calculation_hidden.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + +# Example with mandatory variables not filled in + +```yaml +--- +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: value +var2: example +var3: value +``` diff --git a/tests/results/test_examples/04_1default_calculation_hidden_2.md b/tests/results/test_examples/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..ce8d610 --- /dev/null +++ b/tests/results/test_examples/04_1default_calculation_hidden_2.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + +# Example with mandatory variables not filled in + +```yaml +--- +var2: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: value +var2: example +var3: example +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_optional.md b/tests/results/test_examples/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..1e8f3e6 --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_optional.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# 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) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | + +# Example with all variables modifiable + +```yaml +--- +condition: no +var1: example +var2: example +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_variable.md b/tests/results/test_examples/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..e2cf0de --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_variable.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: false +variable: example +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_variable2.md b/tests/results/test_examples/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..4fee6ae --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_variable2.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: true +variable: example +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_variable3.md b/tests/results/test_examples/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..69ec7c6 --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_variable3.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: yes +variable: example +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_variable4.md b/tests/results/test_examples/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..e17eafe --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_variable4.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: yes +variable: example +``` diff --git a/tests/results/test_examples/04_5validators.md b/tests/results/test_examples/04_5validators.md new file mode 100644 index 0000000..b891cf4 --- /dev/null +++ b/tests/results/test_examples/04_5validators.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with mandatory variables not filled in + +```yaml +--- +int: 42 +``` +# Example with all variables modifiable + +```yaml +--- +int: 42 +``` diff --git a/tests/results/test_examples/04_5validators_differ.md b/tests/results/test_examples/04_5validators_differ.md new file mode 100644 index 0000000..b02b200 --- /dev/null +++ b/tests/results/test_examples/04_5validators_differ.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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
**Example**: another_value | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + +# Example with all variables modifiable + +```yaml +--- +var1: another_value +var2: no +``` diff --git a/tests/results/test_examples/04_5validators_multi.md b/tests/results/test_examples/04_5validators_multi.md new file mode 100644 index 0000000..07c9807 --- /dev/null +++ b/tests/results/test_examples/04_5validators_multi.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | + +# Example with all variables modifiable + +```yaml +--- +var1: + - no + - yes +``` diff --git a/tests/results/test_examples/04_5validators_multi2.md b/tests/results/test_examples/04_5validators_multi2.md new file mode 100644 index 0000000..2bce5e0 --- /dev/null +++ b/tests/results/test_examples/04_5validators_multi2.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | + +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +``` diff --git a/tests/results/test_examples/05_0multi_not_uniq.md b/tests/results/test_examples/05_0multi_not_uniq.md new file mode 100644 index 0000000..e8d46db --- /dev/null +++ b/tests/results/test_examples/05_0multi_not_uniq.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +var1: + - non +``` diff --git a/tests/results/test_examples/05_0multi_uniq.md b/tests/results/test_examples/05_0multi_uniq.md new file mode 100644 index 0000000..f9cf5c8 --- /dev/null +++ b/tests/results/test_examples/05_0multi_uniq.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +variable: + - non +``` diff --git a/tests/results/test_examples/12_1auto_save_expert.md b/tests/results/test_examples/12_1auto_save_expert.md new file mode 100644 index 0000000..3b41aec --- /dev/null +++ b/tests/results/test_examples/12_1auto_save_expert.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` `auto modified` | A variable.
**Default**: no | + +# Example with all variables modifiable + +```yaml +--- +var: no +``` diff --git a/tests/results/test_examples/16_0redefine_description.md b/tests/results/test_examples/16_0redefine_description.md new file mode 100644 index 0000000..2b1aba5 --- /dev/null +++ b/tests/results/test_examples/16_0redefine_description.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | + +# Example with mandatory variables not filled in + +```yaml +--- +var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/results/test_examples/16_2family_redefine_calculation.md b/tests/results/test_examples/16_2family_redefine_calculation.md new file mode 100644 index 0000000..692f549 --- /dev/null +++ b/tests/results/test_examples/16_2family_redefine_calculation.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## family + +`basic` *`disabled`* + +**Disabled**: depends on a calculation. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/16_2family_redefine_disabled.md b/tests/results/test_examples/16_2family_redefine_disabled.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/16_2family_redefine_disabled.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/16_5exists_nonexists.md b/tests/results/test_examples/16_5exists_nonexists.md new file mode 100644 index 0000000..0d83c09 --- /dev/null +++ b/tests/results/test_examples/16_5exists_nonexists.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: yes +``` diff --git a/tests/results/test_examples/16_5exists_redefine.md b/tests/results/test_examples/16_5exists_redefine.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/16_5exists_redefine.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/16_5redefine_calculation.md b/tests/results/test_examples/16_5redefine_calculation.md new file mode 100644 index 0000000..63e4e4f --- /dev/null +++ b/tests/results/test_examples/16_5redefine_calculation.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + +# Example with all variables modifiable + +```yaml +--- +variable: yes +``` diff --git a/tests/results/test_examples/16_5redefine_choice.md b/tests/results/test_examples/16_5redefine_choice.md new file mode 100644 index 0000000..7cfe181 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_choice.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- 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/results/test_examples/16_5redefine_default.md b/tests/results/test_examples/16_5redefine_default.md new file mode 100644 index 0000000..44659d2 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_default.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | + +# Example with all variables modifiable + +```yaml +--- +variable: yes +``` diff --git a/tests/results/test_examples/16_5redefine_default_calculation.md b/tests/results/test_examples/16_5redefine_default_calculation.md new file mode 100644 index 0000000..b21cc88 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_default_calculation.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +variable: example +``` diff --git a/tests/results/test_examples/16_5redefine_family.md b/tests/results/test_examples/16_5redefine_family.md new file mode 100644 index 0000000..3ddcd0e --- /dev/null +++ b/tests/results/test_examples/16_5redefine_family.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/16_5redefine_help.md b/tests/results/test_examples/16_5redefine_help.md new file mode 100644 index 0000000..b44daf0 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_help.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +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. | + +# Example with mandatory variables not filled in + +```yaml +--- +family: + variable: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + variable: example +``` diff --git a/tests/results/test_examples/16_5redefine_hidden.md b/tests/results/test_examples/16_5redefine_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/16_5redefine_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/16_5redefine_multi.md b/tests/results/test_examples/16_5redefine_multi.md new file mode 100644 index 0000000..f9cf5c8 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +variable: + - non +``` diff --git a/tests/results/test_examples/16_5redefine_remove_disable_calculation.md b/tests/results/test_examples/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..014c833 --- /dev/null +++ b/tests/results/test_examples/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with mandatory variables not filled in + +```yaml +--- +variable: example +``` +# Example with all variables modifiable + +```yaml +--- +condition: no +variable: example +``` diff --git a/tests/results/test_examples/16_5test_redefine.md b/tests/results/test_examples/16_5test_redefine.md new file mode 100644 index 0000000..d44e842 --- /dev/null +++ b/tests/results/test_examples/16_5test_redefine.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with mandatory variables not filled in + +```yaml +--- +var3: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: test1 +var2: test1 +var3: example +``` diff --git a/tests/results/test_examples/16_6choice_redefine.md b/tests/results/test_examples/16_6choice_redefine.md new file mode 100644 index 0000000..82ea286 --- /dev/null +++ b/tests/results/test_examples/16_6choice_redefine.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | + +# Example with all variables modifiable + +```yaml +--- +var: c +``` diff --git a/tests/results/test_examples/16_6exists_redefine_family.md b/tests/results/test_examples/16_6exists_redefine_family.md new file mode 100644 index 0000000..ed0bdde --- /dev/null +++ b/tests/results/test_examples/16_6exists_redefine_family.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family1.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a second family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family2.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +family1: + variable1: example +family2: + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +family1: + variable1: example +family2: + variable2: example +``` diff --git a/tests/results/test_examples/16exists_exists.md b/tests/results/test_examples/16exists_exists.md new file mode 100644 index 0000000..b4549c1 --- /dev/null +++ b/tests/results/test_examples/16exists_exists.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | + +# Example with mandatory variables not filled in + +```yaml +--- +var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: example +``` diff --git a/tests/results/test_examples/17_5redefine_leadership.md b/tests/results/test_examples/17_5redefine_leadership.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/17_5redefine_leadership.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/20_0empty_family.md b/tests/results/test_examples/20_0empty_family.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/20_0empty_family.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/20_0family_append.md b/tests/results/test_examples/20_0family_append.md new file mode 100644 index 0000000..8fcd7ef --- /dev/null +++ b/tests/results/test_examples/20_0family_append.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A 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. | + +# 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/results/test_examples/20_0family_underscore.md b/tests/results/test_examples/20_0family_underscore.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/20_0family_underscore.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/20_0multi_family.md b/tests/results/test_examples/20_0multi_family.md new file mode 100644 index 0000000..3cc4be2 --- /dev/null +++ b/tests/results/test_examples/20_0multi_family.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`standard` + +### a sub family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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/results/test_examples/20_0multi_family_basic.md b/tests/results/test_examples/20_0multi_family_basic.md new file mode 100644 index 0000000..321dd56 --- /dev/null +++ b/tests/results/test_examples/20_0multi_family_basic.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +### a sub family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/20_0multi_family_expert.md b/tests/results/test_examples/20_0multi_family_expert.md new file mode 100644 index 0000000..d35e60e --- /dev/null +++ b/tests/results/test_examples/20_0multi_family_expert.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`advanced` + +### a sub family + +`advanced` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` | A variable. | + +# Example with all variables modifiable + +```yaml +--- +family: + subfamily: + variable: example +``` diff --git a/tests/results/test_examples/20_0multi_family_order.md b/tests/results/test_examples/20_0multi_family_order.md new file mode 100644 index 0000000..3c8282f --- /dev/null +++ b/tests/results/test_examples/20_0multi_family_order.md @@ -0,0 +1,52 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + +### 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.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/20_0validators_differ_redefine.md b/tests/results/test_examples/20_0validators_differ_redefine.md new file mode 100644 index 0000000..7fd6eee --- /dev/null +++ b/tests/results/test_examples/20_0validators_differ_redefine.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# 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
**Example**: yes | + +# Example with all variables modifiable + +```yaml +--- +var1: no +var2: no +var3: yes +``` diff --git a/tests/results/test_examples/20_1empty_subfamily.md b/tests/results/test_examples/20_1empty_subfamily.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/20_1empty_subfamily.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/20_9default_information_parent.md b/tests/results/test_examples/20_9default_information_parent.md new file mode 100644 index 0000000..fbd4d06 --- /dev/null +++ b/tests/results/test_examples/20_9default_information_parent.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## 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**: the value of the information "test_information" of the variable "family". | + +# Example with mandatory variables not filled in + +```yaml +--- +family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +family: + var1: example + var2: example +``` diff --git a/tests/results/test_examples/24_0family_hidden_condition_sub_family.md b/tests/results/test_examples/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..2500101 --- /dev/null +++ b/tests/results/test_examples/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: if condition is yes. + +### family.subfamily + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/24_0family_hidden_condition_variable_sub_family.md b/tests/results/test_examples/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..f0854a9 --- /dev/null +++ b/tests/results/test_examples/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: true | + +## possibly hidden family + +`standard` *`hidden`* + +**Hidden**: when the variable "condition" has the value "true". + +### a subfamily + +`standard` + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + +# Example with all variables modifiable + +```yaml +--- +condition: true +family: + subfamily: + var1: example +``` diff --git a/tests/results/test_examples/24_0family_hidden_param_condition_sub_family.md b/tests/results/test_examples/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..fbb8f27 --- /dev/null +++ b/tests/results/test_examples/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The variable use has condition.
**Default**: no | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: if condition is yes. + +### a subfamily + +`basic` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/24_0family_mandatory_condition.md b/tests/results/test_examples/24_0family_mandatory_condition.md new file mode 100644 index 0000000..ec27e70 --- /dev/null +++ b/tests/results/test_examples/24_0family_mandatory_condition.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with all variables modifiable + +```yaml +--- +condition: no +var: example +``` diff --git a/tests/results/test_examples/24_0family_mandatory_condition_variable.md b/tests/results/test_examples/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..d76bb06 --- /dev/null +++ b/tests/results/test_examples/24_0family_mandatory_condition_variable.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# 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". | + +# Example with all variables modifiable + +```yaml +--- +condition: true +var: example +``` diff --git a/tests/results/test_examples/24_7validators_variable_optional.md b/tests/results/test_examples/24_7validators_variable_optional.md new file mode 100644 index 0000000..9296944 --- /dev/null +++ b/tests/results/test_examples/24_7validators_variable_optional.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## 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.
**Example**: 5 | +| **general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | + +# Example with mandatory variables not filled in + +```yaml +--- +general: + int: 5 +``` +# Example with all variables modifiable + +```yaml +--- +general: + int: 5 + int2: 1 +``` diff --git a/tests/results/test_examples/24_family_disabled_var_hidden.md b/tests/results/test_examples/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/24_family_disabled_var_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/40_0leadership.md b/tests/results/test_examples/40_0leadership.md new file mode 100644 index 0000000..bc5d2aa --- /dev/null +++ b/tests/results/test_examples/40_0leadership.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/results/test_examples/40_0leadership_diff_name.md b/tests/results/test_examples/40_0leadership_diff_name.md new file mode 100644 index 0000000..539298b --- /dev/null +++ b/tests/results/test_examples/40_0leadership_diff_name.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/results/test_examples/40_0leadership_empty.md b/tests/results/test_examples/40_0leadership_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/40_0leadership_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/40_0leadership_follower_default_calculation.md b/tests/results/test_examples/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..83c1aa5 --- /dev/null +++ b/tests/results/test_examples/40_0leadership_follower_default_calculation.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: value + follower2: value +``` diff --git a/tests/results/test_examples/40_0leadership_follower_default_value.md b/tests/results/test_examples/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..df4476d --- /dev/null +++ b/tests/results/test_examples/40_0leadership_follower_default_value.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`standard` + +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 | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: value +``` diff --git a/tests/results/test_examples/40_0leadership_leader_not_multi.md b/tests/results/test_examples/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..d3a4518 --- /dev/null +++ b/tests/results/test_examples/40_0leadership_leader_not_multi.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## general + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: 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` `mandatory` `unique` `multiple` | Leader. | +| **general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | +| **general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | + +# Example with all variables modifiable + +```yaml +--- +general: + mode_conteneur_actif: non +general1: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/results/test_examples/40_1leadership_append_follower.md b/tests/results/test_examples/40_1leadership_append_follower.md new file mode 100644 index 0000000..097fa8c --- /dev/null +++ b/tests/results/test_examples/40_1leadership_append_follower.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example + follower3: example +``` diff --git a/tests/results/test_examples/40_6leadership_follower_multi.md b/tests/results/test_examples/40_6leadership_follower_multi.md new file mode 100644 index 0000000..2834be2 --- /dev/null +++ b/tests/results/test_examples/40_6leadership_follower_multi.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A leadership + +`basic` + +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 | + +# Example with all variables modifiable + +```yaml +--- +leadership: + - leader: example + follower1: + - example + follower2: + - value +``` diff --git a/tests/results/test_examples/40_8calculation_boolean.md b/tests/results/test_examples/40_8calculation_boolean.md new file mode 100644 index 0000000..9217c43 --- /dev/null +++ b/tests/results/test_examples/40_8calculation_boolean.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# 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. | + +# Example with all variables modifiable + +```yaml +--- +bool: false +multi1: + - false +multi2: + - true + - false +``` diff --git a/tests/results/test_examples/40_8calculation_multi_variable.md b/tests/results/test_examples/40_8calculation_multi_variable.md new file mode 100644 index 0000000..91cfbea --- /dev/null +++ b/tests/results/test_examples/40_8calculation_multi_variable.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +# Example with all variables modifiable + +```yaml +--- +var: + - no + - yes +var2: no +var3: yes +``` diff --git a/tests/results/test_examples/40_8calculation_multi_variable_parent.md b/tests/results/test_examples/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..ab31e48 --- /dev/null +++ b/tests/results/test_examples/40_8calculation_multi_variable_parent.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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". | + +# Example with all variables modifiable + +```yaml +--- +var: no +fam1: + var: no +``` diff --git a/tests/results/test_examples/40_8calculation_multi_variable_parent2.md b/tests/results/test_examples/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..511f091 --- /dev/null +++ b/tests/results/test_examples/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,31 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## first family + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **fam1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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". | + +# Example with all variables modifiable + +```yaml +--- +fam1: + var: no +fam2: + var: no +``` diff --git a/tests/results/test_examples/41_0choice_leader.md b/tests/results/test_examples/41_0choice_leader.md new file mode 100644 index 0000000..5341f8b --- /dev/null +++ b/tests/results/test_examples/41_0choice_leader.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## The leadership + +`basic` + +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 | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: a_choice +``` diff --git a/tests/results/test_examples/44_0leadership_hidden.md b/tests/results/test_examples/44_0leadership_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/44_0leadership_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/44_0leadership_leader_hidden.md b/tests/results/test_examples/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/44_0leadership_leader_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/44_1leadership_append_hidden_follower.md b/tests/results/test_examples/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/44_1leadership_append_hidden_follower.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/44_4leadership_mandatory.md b/tests/results/test_examples/44_4leadership_mandatory.md new file mode 100644 index 0000000..26738f1 --- /dev/null +++ b/tests/results/test_examples/44_4leadership_mandatory.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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` | A follower. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example +``` diff --git a/tests/results/test_examples/44_4leadership_mandatory_follower.md b/tests/results/test_examples/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..12d6dae --- /dev/null +++ b/tests/results/test_examples/44_4leadership_mandatory_follower.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower: example +``` diff --git a/tests/results/test_examples/44_5leadership_leader_hidden_calculation.md b/tests/results/test_examples/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..7278166 --- /dev/null +++ b/tests/results/test_examples/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | + +## a leadership + +`basic` *`hidden`* + +**Hidden**: if condition is no. + +This family contains lists of variable blocks. + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **leader.leader**
[`string`](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. | + +# Example with all variables modifiable + +```yaml +--- +condition: no +leader: + - leader: example + follower: example +``` diff --git a/tests/results/test_examples/44_6leadership_follower_disabled_calculation.md b/tests/results/test_examples/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..04bdb41 --- /dev/null +++ b/tests/results/test_examples/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | + +## a leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +condition: yes +leader: + - leader: example + follower: example +``` diff --git a/tests/results/test_examples/60_0family_dynamic.md b/tests/results/test_examples/60_0family_dynamic.md new file mode 100644 index 0000000..615e5ba --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/60_0family_dynamic_1_1.md b/tests/results/test_examples/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..81a05fe --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_1_1.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/60_0family_dynamic_1_1_empty.md b/tests/results/test_examples/60_0family_dynamic_1_1_empty.md new file mode 100644 index 0000000..3329293 --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_1_1_empty.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/60_0family_dynamic_empty.md b/tests/results/test_examples/60_0family_dynamic_empty.md new file mode 100644 index 0000000..283afff --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_empty.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable. | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +dynexample: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var: + - example +dynexample: + var: example +``` diff --git a/tests/results/test_examples/60_0family_dynamic_no_description.md b/tests/results/test_examples/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..4f0069f --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_no_description.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + +# 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/results/test_examples/60_0family_dynamic_no_description_empty.md b/tests/results/test_examples/60_0family_dynamic_no_description_empty.md new file mode 100644 index 0000000..9068016 --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_no_description_empty.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + +# 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/results/test_examples/60_0family_dynamic_static.md b/tests/results/test_examples/60_0family_dynamic_static.md new file mode 100644 index 0000000..65bb15e --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_static.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/60_0family_dynamic_test.md b/tests/results/test_examples/60_0family_dynamic_test.md new file mode 100644 index 0000000..0b08f14 --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_test.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +var: + - val1 + - val2 +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/results/test_examples/60_0family_dynamic_variable_empty.md b/tests/results/test_examples/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..6059cdb --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_variable_empty.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: 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/results/test_examples/60_0family_dynamic_variable_suffix.md b/tests/results/test_examples/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..f82e141 --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_variable_suffix.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: a value +dynval2: + var: a value +``` diff --git a/tests/results/test_examples/60_0family_dynamic_variable_suffix_empty.md b/tests/results/test_examples/60_0family_dynamic_variable_suffix_empty.md new file mode 100644 index 0000000..9d8a7ef --- /dev/null +++ b/tests/results/test_examples/60_0family_dynamic_variable_suffix_empty.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + +# Example with mandatory variables not filled in + +```yaml +--- +var: + - val1 + - val2 +``` +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: a value +dynval2: + var: a value +``` diff --git a/tests/results/test_examples/60_0family_empty.md b/tests/results/test_examples/60_0family_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/60_0family_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/60_0family_hidden.md b/tests/results/test_examples/60_0family_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_examples/60_0family_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_examples/60_0family_mode.md b/tests/results/test_examples/60_0family_mode.md new file mode 100644 index 0000000..085d3bc --- /dev/null +++ b/tests/results/test_examples/60_0family_mode.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +family: + var: non +``` diff --git a/tests/results/test_examples/60_1family_dynamic_jinja.md b/tests/results/test_examples/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..9ea87af --- /dev/null +++ b/tests/results/test_examples/60_1family_dynamic_jinja.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: index of suffix value. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*1*.var**
**dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dyn1: + var: val +dyn2: + var: val +``` diff --git a/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group.md b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..a121ffb --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +### a family + +`basic` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + family: + var: example +dynval2: + family: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +``` diff --git a/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..73672cd --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the 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. | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + family: + var: val1 +dynval2: + family: + var: val2 +var2: val1 +``` diff --git a/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md new file mode 100644 index 0000000..ead993f --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A varible outside dynamic family.
**Default**: 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/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md new file mode 100644 index 0000000..fab3e21 --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +### a family + +`basic` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + family: + var: example +dynval2: + family: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + family: + var: example +dynval2: + family: + var: example +var2: example +``` diff --git a/tests/results/test_examples/60_2family_dynamic_outside_calc.md b/tests/results/test_examples/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..7b53b2d --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_outside_calc.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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. | + +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + var: val +dynval2: + var: val +newvar: val +``` diff --git a/tests/results/test_examples/60_2family_dynamic_outside_calc_empty.md b/tests/results/test_examples/60_2family_dynamic_outside_calc_empty.md new file mode 100644 index 0000000..66550d5 --- /dev/null +++ b/tests/results/test_examples/60_2family_dynamic_outside_calc_empty.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffx variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: 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/results/test_examples/60_5family_dynamic_calc_suffix2.md b/tests/results/test_examples/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..ba0896d --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/results/test_examples/60_5family_dynamic_calc_suffix2_empty.md b/tests/results/test_examples/60_5family_dynamic_calc_suffix2_empty.md new file mode 100644 index 0000000..fdfa6a5 --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_suffix2_empty.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/results/test_examples/60_5family_dynamic_calc_suffix_param.md b/tests/results/test_examples/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..27ac225 --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/results/test_examples/60_5family_dynamic_calc_suffix_param_empty.md b/tests/results/test_examples/60_5family_dynamic_calc_suffix_param_empty.md new file mode 100644 index 0000000..f34508f --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_suffix_param_empty.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dynval1: + var: val1 +dynval2: + var: val2 +``` diff --git a/tests/results/test_examples/60_5family_dynamic_calc_variable.md b/tests/results/test_examples/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..939c8e4 --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_variable.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## dyn*val1* or dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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". | + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +var2: example +``` diff --git a/tests/results/test_examples/60_5family_dynamic_calc_variable_empty.md b/tests/results/test_examples/60_5family_dynamic_calc_variable_empty.md new file mode 100644 index 0000000..ee4e696 --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_calc_variable_empty.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## dyn*val1* or dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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 "dyn*val1*.var"
- the value of the variable "dyn*val2*.var" | + +# Example with mandatory variables not filled in + +```yaml +--- +dynval1: + var: example +dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +var1: + - val1 + - val2 +dynval1: + var: example +dynval2: + var: example +var2: example +``` diff --git a/tests/results/test_examples/60_5family_dynamic_hidden_suffix.md b/tests/results/test_examples/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..af91ca9 --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## a dynamic family + +`standard` *`hidden`* + +**Hidden**: if suffix == 'val2'. + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.var**
**dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + +### a family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.family.var**
**dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | + +# Example with all variables modifiable + +```yaml +--- +dynval1: + var: example + family: + var: example +dynval2: + var: example + family: + var: example +``` diff --git a/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix.md b/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..1b6006a --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_*val1*.var**
**dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the 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". | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dyn_val1: + var: val1 +dyn_val2: + var: val2 +var2: val1 +``` diff --git a/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix_empty.md b/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix_empty.md new file mode 100644 index 0000000..f4e128e --- /dev/null +++ b/tests/results/test_examples/60_5family_dynamic_variable_outside_suffix_empty.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Asuffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn_*val1*.var**
**dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**:
- the value of the variable "dyn_*val1*.var"
- the value of the variable "dyn_*val2*.var" | + +# Example with all variables modifiable + +```yaml +--- +var: + - val1 + - val2 +dyn_val1: + var: val1 +dyn_val2: + var: val2 +var2: val1 +``` diff --git a/tests/results/test_examples/60_6family_dynamic_leadership.md b/tests/results/test_examples/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..ffe420d --- /dev/null +++ b/tests/results/test_examples/60_6family_dynamic_leadership.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# 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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.leadership.leader**
**dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dyn*val1*.leadership.follower1**
**dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dyn*val1*.leadership.follower2**
**dyn*val2*.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/results/test_examples/60_6family_dynamic_leadership_empty.md b/tests/results/test_examples/60_6family_dynamic_leadership_empty.md new file mode 100644 index 0000000..2633f76 --- /dev/null +++ b/tests/results/test_examples/60_6family_dynamic_leadership_empty.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.leadership.leader**
**dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **dyn*val1*.leadership.follower1**
**dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **dyn*val1*.leadership.follower2**
**dyn*val2*.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/results/test_examples/60_9family_dynamic_calc_both.md b/tests/results/test_examples/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..25c6e74 --- /dev/null +++ b/tests/results/test_examples/60_9family_dynamic_calc_both.md @@ -0,0 +1,41 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- the value of the variable "var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dyn*val1*.vardyn**
**dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_examples/68_0family_leadership_mode.md b/tests/results/test_examples/68_0family_leadership_mode.md new file mode 100644 index 0000000..dafd54b --- /dev/null +++ b/tests/results/test_examples/68_0family_leadership_mode.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +## A leadership + +`basic` + +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. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/results/test_namespace/00_0empty.adoc b/tests/results/test_namespace/00_0empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/00_0empty.json b/tests/results/test_namespace/00_0empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/00_0empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/00_0empty.md b/tests/results/test_namespace/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/00_0empty.sh b/tests/results/test_namespace/00_0empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/00_0version_underscore.adoc b/tests/results/test_namespace/00_0version_underscore.adoc similarity index 72% rename from tests/docs/base/00_0version_underscore.adoc rename to tests/results/test_namespace/00_0version_underscore.adoc index acbdeb1..ab59d9b 100644 --- a/tests/docs/base/00_0version_underscore.adoc +++ b/tests/results/test_namespace/00_0version_underscore.adoc @@ -1,11 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -_version: '1.1' -version: # a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_0version_underscore.json b/tests/results/test_namespace/00_0version_underscore.json similarity index 100% rename from tests/docs/base/00_0version_underscore.json rename to tests/results/test_namespace/00_0version_underscore.json diff --git a/tests/docs/base/00_0version_underscore.md b/tests/results/test_namespace/00_0version_underscore.md similarity index 97% rename from tests/docs/base/00_0version_underscore.md rename to tests/results/test_namespace/00_0version_underscore.md index a7417bc..644a2f7 100644 --- a/tests/docs/base/00_0version_underscore.md +++ b/tests/results/test_namespace/00_0version_underscore.md @@ -2,13 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -_version: '1.1' -version: # a variable -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | diff --git a/tests/results/test_namespace/00_0version_underscore.sh b/tests/results/test_namespace/00_0version_underscore.sh new file mode 100644 index 0000000..9b7a7fc --- /dev/null +++ b/tests/results/test_namespace/00_0version_underscore.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.version + string basic mandatory A variable. + diff --git a/tests/docs/base/00_1empty_variable.adoc b/tests/results/test_namespace/00_1empty_variable.adoc similarity index 75% rename from tests/docs/base/00_1empty_variable.adoc rename to tests/results/test_namespace/00_1empty_variable.adoc index 701a9d0..11d79fc 100644 --- a/tests/docs/base/00_1empty_variable.adoc +++ b/tests/results/test_namespace/00_1empty_variable.adoc @@ -1,11 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -empty: ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_1empty_variable.json b/tests/results/test_namespace/00_1empty_variable.json similarity index 100% rename from tests/docs/base/00_1empty_variable.json rename to tests/results/test_namespace/00_1empty_variable.json diff --git a/tests/docs/base/00_1empty_variable.md b/tests/results/test_namespace/00_1empty_variable.md similarity index 97% rename from tests/docs/base/00_1empty_variable.md rename to tests/results/test_namespace/00_1empty_variable.md index 04e50bb..0c46b56 100644 --- a/tests/docs/base/00_1empty_variable.md +++ b/tests/results/test_namespace/00_1empty_variable.md @@ -2,13 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -empty: -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | diff --git a/tests/results/test_namespace/00_1empty_variable.sh b/tests/results/test_namespace/00_1empty_variable.sh new file mode 100644 index 0000000..adfb182 --- /dev/null +++ b/tests/results/test_namespace/00_1empty_variable.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.empty + string basic mandatory Empty. + diff --git a/tests/docs/base/00_2default_calculated.adoc b/tests/results/test_namespace/00_2default_calculated.adoc similarity index 68% rename from tests/docs/base/00_2default_calculated.adoc rename to tests/results/test_namespace/00_2default_calculated.adoc index f61fea8..b02ff54 100644 --- a/tests/docs/base/00_2default_calculated.adoc +++ b/tests/results/test_namespace/00_2default_calculated.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - multi: true - default: - jinja: | - {{ _.var1 }} - description: the value of var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_2default_calculated.json b/tests/results/test_namespace/00_2default_calculated.json similarity index 100% rename from tests/docs/base/00_2default_calculated.json rename to tests/results/test_namespace/00_2default_calculated.json diff --git a/tests/results/test_namespace/00_2default_calculated.md b/tests/results/test_namespace/00_2default_calculated.md new file mode 100644 index 0000000..6713953 --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/00_2default_calculated.sh b/tests/results/test_namespace/00_2default_calculated.sh new file mode 100644 index 0000000..ad588bb --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string standard mandatory unique A second variable. + multiple + Default: the value of var1. + diff --git a/tests/docs/base/00_2default_calculated_multi.adoc b/tests/results/test_namespace/00_2default_calculated_multi.adoc similarity index 64% rename from tests/docs/base/00_2default_calculated_multi.adoc rename to tests/results/test_namespace/00_2default_calculated_multi.adoc index b0dd12b..664a150 100644 --- a/tests/docs/base/00_2default_calculated_multi.adoc +++ b/tests/results/test_namespace/00_2default_calculated_multi.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var1: # a first variable - - no - - yes - - maybe -var2: - description: a second variable - multi: true - default: - jinja: | - {% for val in _.var1 %} - {{ val }} - {% endfor %} - description: the value of _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_2default_calculated_multi.json b/tests/results/test_namespace/00_2default_calculated_multi.json similarity index 100% rename from tests/docs/base/00_2default_calculated_multi.json rename to tests/results/test_namespace/00_2default_calculated_multi.json diff --git a/tests/results/test_namespace/00_2default_calculated_multi.md b/tests/results/test_namespace/00_2default_calculated_multi.md new file mode 100644 index 0000000..7b6d4b5 --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/00_2default_calculated_multi.sh b/tests/results/test_namespace/00_2default_calculated_multi.sh new file mode 100644 index 0000000..ef1a3f1 --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A first variable. + multiple + Default: + + + • no + • yes + • maybe + | | rougail.var2 string standard mandatory unique multiple + | A second variable. Default: the value of _.var1. + | diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.adoc b/tests/results/test_namespace/00_2default_calculated_variable_transitive.adoc similarity index 70% rename from tests/docs/base/00_2default_calculated_variable_transitive.adoc rename to tests/results/test_namespace/00_2default_calculated_variable_transitive.adoc index 2001120..01ce4ad 100644 --- a/tests/docs/base/00_2default_calculated_variable_transitive.adoc +++ b/tests/results/test_namespace/00_2default_calculated_variable_transitive.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 - -var1: - description: a first variable - multi: true - type: domainname - params: - allow_ip: true - -var2: - description: a second variable - default: - type: variable - variable: _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.json b/tests/results/test_namespace/00_2default_calculated_variable_transitive.json similarity index 100% rename from tests/docs/base/00_2default_calculated_variable_transitive.json rename to tests/results/test_namespace/00_2default_calculated_variable_transitive.json diff --git a/tests/results/test_namespace/00_2default_calculated_variable_transitive.md b/tests/results/test_namespace/00_2default_calculated_variable_transitive.md new file mode 100644 index 0000000..984e1bd --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated_variable_transitive.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                           | Description                                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | +| **rougail.var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "rougail.var1". | + diff --git a/tests/results/test_namespace/00_2default_calculated_variable_transitive.sh b/tests/results/test_namespace/00_2default_calculated_variable_transitive.sh new file mode 100644 index 0000000..67e85f5 --- /dev/null +++ b/tests/results/test_namespace/00_2default_calculated_variable_transitive.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + domainname basic mandatory unique A first variable. + multiple + Validator: the domain name can be an + IP + rougail.var2 + domainname standard mandatory unique A second variable. + multiple + Validator: the domain name can be an + IP + Default: the value of the variable + "rougail.var1". + diff --git a/tests/docs/base/00_4load_subfolder.adoc b/tests/results/test_namespace/00_4load_subfolder.adoc similarity index 66% rename from tests/docs/base/00_4load_subfolder.adoc rename to tests/results/test_namespace/00_4load_subfolder.adoc index 1c87836..8a6edc8 100644 --- a/tests/docs/base/00_4load_subfolder.adoc +++ b/tests/results/test_namespace/00_4load_subfolder.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/99-base.yml - -[,yaml] ----- ---- -version: '1.0' -var1: - description: a variable ----- -== dictionaries/rougail2/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var2: - description: a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_4load_subfolder.json b/tests/results/test_namespace/00_4load_subfolder.json similarity index 100% rename from tests/docs/base/00_4load_subfolder.json rename to tests/results/test_namespace/00_4load_subfolder.json diff --git a/tests/results/test_namespace/00_4load_subfolder.md b/tests/results/test_namespace/00_4load_subfolder.md new file mode 100644 index 0000000..acb4017 --- /dev/null +++ b/tests/results/test_namespace/00_4load_subfolder.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/00_4load_subfolder.sh b/tests/results/test_namespace/00_4load_subfolder.sh new file mode 100644 index 0000000..db2fa2b --- /dev/null +++ b/tests/results/test_namespace/00_4load_subfolder.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A variable. + rougail.var2 + string basic mandatory A variable. + diff --git a/tests/docs/base/00_5load_notype.adoc b/tests/results/test_namespace/00_5load_notype.adoc similarity index 68% rename from tests/docs/base/00_5load_notype.adoc rename to tests/results/test_namespace/00_5load_notype.adoc index e82c61c..0ea9502 100644 --- a/tests/docs/base/00_5load_notype.adoc +++ b/tests/results/test_namespace/00_5load_notype.adoc @@ -1,13 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -without_type: - description: a variable - default: non ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_5load_notype.json b/tests/results/test_namespace/00_5load_notype.json similarity index 100% rename from tests/docs/base/00_5load_notype.json rename to tests/results/test_namespace/00_5load_notype.json diff --git a/tests/results/test_namespace/00_5load_notype.md b/tests/results/test_namespace/00_5load_notype.md new file mode 100644 index 0000000..d47e113 --- /dev/null +++ b/tests/results/test_namespace/00_5load_notype.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | + diff --git a/tests/results/test_namespace/00_5load_notype.sh b/tests/results/test_namespace/00_5load_notype.sh new file mode 100644 index 0000000..0885632 --- /dev/null +++ b/tests/results/test_namespace/00_5load_notype.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.without_type + string standard mandatory A variable. + Default: non + diff --git a/tests/docs/base/00_6boolean.adoc b/tests/results/test_namespace/00_6boolean.adoc similarity index 76% rename from tests/docs/base/00_6boolean.adoc rename to tests/results/test_namespace/00_6boolean.adoc index 5a6fc59..2c164d6 100644 --- a/tests/docs/base/00_6boolean.adoc +++ b/tests/results/test_namespace/00_6boolean.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: true # the first variable -var2: - description: the second variable - default: true -var3: - description: the third variable - type: boolean - default: true -var4: false # the forth variable -var5: - description: the fifth variable - default: false -var6: - description: the sixth variable - type: boolean - default: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6boolean.json b/tests/results/test_namespace/00_6boolean.json similarity index 100% rename from tests/docs/base/00_6boolean.json rename to tests/results/test_namespace/00_6boolean.json diff --git a/tests/results/test_namespace/00_6boolean.md b/tests/results/test_namespace/00_6boolean.md new file mode 100644 index 0000000..cd6bd15 --- /dev/null +++ b/tests/results/test_namespace/00_6boolean.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/docs/base/00_6boolean.sh b/tests/results/test_namespace/00_6boolean.sh similarity index 60% rename from tests/docs/base/00_6boolean.sh rename to tests/results/test_namespace/00_6boolean.sh index 8f5cab8..bd79df1 100644 --- a/tests/docs/base/00_6boolean.sh +++ b/tests/results/test_namespace/00_6boolean.sh @@ -1,28 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: true # the first variable -var2: - description: the second variable - default: true -var3: - description: the third variable - type: boolean - default: true -var4: false # the forth variable -var5: - description: the fifth variable - default: false -var6: - description: the sixth variable - type: boolean - default: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ diff --git a/tests/docs/base/00_6boolean_no_mandatory.adoc b/tests/results/test_namespace/00_6boolean_no_mandatory.adoc similarity index 64% rename from tests/docs/base/00_6boolean_no_mandatory.adoc rename to tests/results/test_namespace/00_6boolean_no_mandatory.adoc index 43188ba..975fe9b 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.adoc +++ b/tests/results/test_namespace/00_6boolean_no_mandatory.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - type: boolean - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6boolean_no_mandatory.json b/tests/results/test_namespace/00_6boolean_no_mandatory.json similarity index 100% rename from tests/docs/base/00_6boolean_no_mandatory.json rename to tests/results/test_namespace/00_6boolean_no_mandatory.json diff --git a/tests/results/test_namespace/00_6boolean_no_mandatory.md b/tests/results/test_namespace/00_6boolean_no_mandatory.md new file mode 100644 index 0000000..18b4ce3 --- /dev/null +++ b/tests/results/test_namespace/00_6boolean_no_mandatory.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                        | Description                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | + diff --git a/tests/results/test_namespace/00_6boolean_no_mandatory.sh b/tests/results/test_namespace/00_6boolean_no_mandatory.sh new file mode 100644 index 0000000..a99b10c --- /dev/null +++ b/tests/results/test_namespace/00_6boolean_no_mandatory.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                Description            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + boolean standard A variable. + Default: true + diff --git a/tests/docs/base/00_6choice.adoc b/tests/results/test_namespace/00_6choice.adoc similarity index 69% rename from tests/docs/base/00_6choice.adoc rename to tests/results/test_namespace/00_6choice.adoc index c68cce7..256119c 100644 --- a/tests/docs/base/00_6choice.adoc +++ b/tests/results/test_namespace/00_6choice.adoc @@ -1,50 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: the first variable - choices: - - a - - b - - c -var2: - description: the second variable - choices: - - a - - b - - c -var3: - description: the third variable - choices: - - a - - b - - c - mandatory: false -var4: - description: the forth variable - choices: - - - - b - - c - mandatory: false -var5: - description: the fifth variable - choices: - - a - - b - - c - default: a -var6: - description: the sixth variable - choices: - - 1 - - 2 - - 3 - default: 1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6choice.json b/tests/results/test_namespace/00_6choice.json similarity index 100% rename from tests/docs/base/00_6choice.json rename to tests/results/test_namespace/00_6choice.json diff --git a/tests/results/test_namespace/00_6choice.md b/tests/results/test_namespace/00_6choice.md new file mode 100644 index 0000000..1ce624e --- /dev/null +++ b/tests/results/test_namespace/00_6choice.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6choice.sh b/tests/results/test_namespace/00_6choice.sh new file mode 100644 index 0000000..4d5e87e --- /dev/null +++ b/tests/results/test_namespace/00_6choice.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + choice basic mandatory The first variable. + Choices: + + + • a + • b + • c + | | rougail.var2 choice basic mandatory + | The second variable. Choices: + • a + • b + • c + | | rougail.var3 choice standard + | The third variable. Choices: + • a + • b + • c + • null + | | rougail.var4 choice standard + | The forth variable. Choices: + • null + • b + • c + | | rougail.var5 choice standard mandatory + | The fifth variable. Choices: + • a ← (default) + • b + • c + | | rougail.var6 choice standard mandatory + | The sixth variable. Choices: + • 1 ← (default) + • 2 + • 3 + | diff --git a/tests/docs/base/00_6choice_calculation.adoc b/tests/results/test_namespace/00_6choice_calculation.adoc similarity index 53% rename from tests/docs/base/00_6choice_calculation.adoc rename to tests/results/test_namespace/00_6choice_calculation.adoc index 38931bc..38e0998 100644 --- a/tests/docs/base/00_6choice_calculation.adoc +++ b/tests/results/test_namespace/00_6choice_calculation.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var: - description: a variable - default: 9 - choices: - jinja: | - {% for n in trange(0, 10) %} - {{ n }} - {% endfor %} - return_type: number - description: choices is 0 to 9 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6choice_calculation.json b/tests/results/test_namespace/00_6choice_calculation.json similarity index 100% rename from tests/docs/base/00_6choice_calculation.json rename to tests/results/test_namespace/00_6choice_calculation.json diff --git a/tests/results/test_namespace/00_6choice_calculation.md b/tests/results/test_namespace/00_6choice_calculation.md new file mode 100644 index 0000000..1d7d758 --- /dev/null +++ b/tests/results/test_namespace/00_6choice_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6choice_calculation.sh b/tests/results/test_namespace/00_6choice_calculation.sh new file mode 100644 index 0000000..976f232 --- /dev/null +++ b/tests/results/test_namespace/00_6choice_calculation.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A variable. + Choices: choices is 0 to 9. + Default: 9 + diff --git a/tests/docs/base/00_6choice_variable.adoc b/tests/results/test_namespace/00_6choice_variable.adoc similarity index 73% rename from tests/docs/base/00_6choice_variable.adoc rename to tests/results/test_namespace/00_6choice_variable.adoc index 14324ef..4251833 100644 --- a/tests/docs/base/00_6choice_variable.adoc +++ b/tests/results/test_namespace/00_6choice_variable.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # a second variable - - a - - b - - c -var2: - description: a first variable - default: a - choices: - variable: _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6choice_variable.json b/tests/results/test_namespace/00_6choice_variable.json similarity index 100% rename from tests/docs/base/00_6choice_variable.json rename to tests/results/test_namespace/00_6choice_variable.json diff --git a/tests/results/test_namespace/00_6choice_variable.md b/tests/results/test_namespace/00_6choice_variable.md new file mode 100644 index 0000000..76dc3b7 --- /dev/null +++ b/tests/results/test_namespace/00_6choice_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6choice_variable.sh b/tests/results/test_namespace/00_6choice_variable.sh new file mode 100644 index 0000000..57ca1ef --- /dev/null +++ b/tests/results/test_namespace/00_6choice_variable.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A second variable. + multiple + Default: + + + • a + • b + • c + | | rougail.var2 choice standard mandatory + | A first variable. Choices: the value of the variable "rougail.var1". + Default: a + | diff --git a/tests/docs/base/00_6custom.adoc b/tests/results/test_namespace/00_6custom.adoc similarity index 69% rename from tests/docs/base/00_6custom.adoc rename to tests/results/test_namespace/00_6custom.adoc index 32d416f..91a07d6 100644 --- a/tests/docs/base/00_6custom.adoc +++ b/tests/results/test_namespace/00_6custom.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -custom1: - description: the first variable - type: custom -custom2: - description: the seconf variable - type: custom - default: value ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6custom.json b/tests/results/test_namespace/00_6custom.json similarity index 100% rename from tests/docs/base/00_6custom.json rename to tests/results/test_namespace/00_6custom.json diff --git a/tests/results/test_namespace/00_6custom.md b/tests/results/test_namespace/00_6custom.md new file mode 100644 index 0000000..6103eeb --- /dev/null +++ b/tests/results/test_namespace/00_6custom.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6custom.sh b/tests/results/test_namespace/00_6custom.sh new file mode 100644 index 0000000..af25852 --- /dev/null +++ b/tests/results/test_namespace/00_6custom.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.custom1 + custom basic mandatory The first variable. + rougail.custom2 + custom standard mandatory The seconf variable. + Default: value + diff --git a/tests/docs/base/00_6domainname.adoc b/tests/results/test_namespace/00_6domainname.adoc similarity index 64% rename from tests/docs/base/00_6domainname.adoc rename to tests/results/test_namespace/00_6domainname.adoc index 5a49795..3c7df6b 100644 --- a/tests/docs/base/00_6domainname.adoc +++ b/tests/results/test_namespace/00_6domainname.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6domainname.json b/tests/results/test_namespace/00_6domainname.json similarity index 100% rename from tests/docs/base/00_6domainname.json rename to tests/results/test_namespace/00_6domainname.json diff --git a/tests/results/test_namespace/00_6domainname.md b/tests/results/test_namespace/00_6domainname.md new file mode 100644 index 0000000..99cd645 --- /dev/null +++ b/tests/results/test_namespace/00_6domainname.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6domainname.sh b/tests/results/test_namespace/00_6domainname.sh new file mode 100644 index 0000000..74b3d03 --- /dev/null +++ b/tests/results/test_namespace/00_6domainname.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + domainname standard mandatory A domain name variable. + Default: my.domain.name + diff --git a/tests/docs/base/00_6domainname_params.adoc b/tests/results/test_namespace/00_6domainname_params.adoc similarity index 64% rename from tests/docs/base/00_6domainname_params.adoc rename to tests/results/test_namespace/00_6domainname_params.adoc index ceaec45..ca51c1b 100644 --- a/tests/docs/base/00_6domainname_params.adoc +++ b/tests/results/test_namespace/00_6domainname_params.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name - params: - allow_ip: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6domainname_params.json b/tests/results/test_namespace/00_6domainname_params.json similarity index 100% rename from tests/docs/base/00_6domainname_params.json rename to tests/results/test_namespace/00_6domainname_params.json diff --git a/tests/results/test_namespace/00_6domainname_params.md b/tests/results/test_namespace/00_6domainname_params.md new file mode 100644 index 0000000..cd50ef5 --- /dev/null +++ b/tests/results/test_namespace/00_6domainname_params.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_6domainname_params.sh b/tests/results/test_namespace/00_6domainname_params.sh new file mode 100644 index 0000000..7061522 --- /dev/null +++ b/tests/results/test_namespace/00_6domainname_params.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + domainname standard mandatory A domain name variable. + Validator: the domain name can be an + IP + Default: my.domain.name + diff --git a/tests/docs/base/00_6float.adoc b/tests/results/test_namespace/00_6float.adoc similarity index 76% rename from tests/docs/base/00_6float.adoc rename to tests/results/test_namespace/00_6float.adoc index ae54776..0ed331d 100644 --- a/tests/docs/base/00_6float.adoc +++ b/tests/results/test_namespace/00_6float.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: 0.0 # the first variable -var2: - description: the second variable - default: 0.0 -var3: - description: the third variable - type: float - default: 0.0 -var4: 10.1 # the forth variable -var5: - description: the fifth variable - default: 10.1 -var6: - description: the sixth variable - type: float - default: 10.1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6float.json b/tests/results/test_namespace/00_6float.json similarity index 100% rename from tests/docs/base/00_6float.json rename to tests/results/test_namespace/00_6float.json diff --git a/tests/results/test_namespace/00_6float.md b/tests/results/test_namespace/00_6float.md new file mode 100644 index 0000000..7fd0f98 --- /dev/null +++ b/tests/results/test_namespace/00_6float.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/docs/base/00_6float.sh b/tests/results/test_namespace/00_6float.sh similarity index 59% rename from tests/docs/base/00_6float.sh rename to tests/results/test_namespace/00_6float.sh index c17318a..d84de33 100644 --- a/tests/docs/base/00_6float.sh +++ b/tests/results/test_namespace/00_6float.sh @@ -1,28 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: 0.0 # the first variable -var2: - description: the second variable - default: 0.0 -var3: - description: the third variable - type: float - default: 0.0 -var4: 10.1 # the forth variable -var5: - description: the fifth variable - default: 10.1 -var6: - description: the sixth variable - type: float - default: 10.1 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ diff --git a/tests/docs/base/00_6number.adoc b/tests/results/test_namespace/00_6number.adoc similarity index 76% rename from tests/docs/base/00_6number.adoc rename to tests/results/test_namespace/00_6number.adoc index 7307a04..f5a3880 100644 --- a/tests/docs/base/00_6number.adoc +++ b/tests/results/test_namespace/00_6number.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: 0 # the first variable -var2: - description: the second variable - default: 0 -var3: - description: the third variable - type: number - default: 0 -var4: 10 # this forth variable -var5: - description: the fifth variable - default: 10 -var6: - description: the sixth variable - type: number - default: 10 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6number.json b/tests/results/test_namespace/00_6number.json similarity index 100% rename from tests/docs/base/00_6number.json rename to tests/results/test_namespace/00_6number.json diff --git a/tests/results/test_namespace/00_6number.md b/tests/results/test_namespace/00_6number.md new file mode 100644 index 0000000..e6182be --- /dev/null +++ b/tests/results/test_namespace/00_6number.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/docs/base/00_6number.sh b/tests/results/test_namespace/00_6number.sh similarity index 60% rename from tests/docs/base/00_6number.sh rename to tests/results/test_namespace/00_6number.sh index 8e48378..170790f 100644 --- a/tests/docs/base/00_6number.sh +++ b/tests/results/test_namespace/00_6number.sh @@ -1,28 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: 0 # the first variable -var2: - description: the second variable - default: 0 -var3: - description: the third variable - type: number - default: 0 -var4: 10 # this forth variable -var5: - description: the fifth variable - default: 10 -var6: - description: the sixth variable - type: number - default: 10 -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ diff --git a/tests/docs/base/00_6port.adoc b/tests/results/test_namespace/00_6port.adoc similarity index 68% rename from tests/docs/base/00_6port.adoc rename to tests/results/test_namespace/00_6port.adoc index fcefcfa..103550b 100644 --- a/tests/docs/base/00_6port.adoc +++ b/tests/results/test_namespace/00_6port.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable1: - description: a port variable - type: port -variable2: - description: a port variable with default value - type: port - default: '8080' -variable3: - description: a port variable with integer default value - type: port - default: 8080 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6port.json b/tests/results/test_namespace/00_6port.json similarity index 100% rename from tests/docs/base/00_6port.json rename to tests/results/test_namespace/00_6port.json diff --git a/tests/results/test_namespace/00_6port.md b/tests/results/test_namespace/00_6port.md new file mode 100644 index 0000000..6415824 --- /dev/null +++ b/tests/results/test_namespace/00_6port.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable. | +| **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | +| **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | + diff --git a/tests/results/test_namespace/00_6port.sh b/tests/results/test_namespace/00_6port.sh new file mode 100644 index 0000000..bff89b4 --- /dev/null +++ b/tests/results/test_namespace/00_6port.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + port basic mandatory A port variable. + rougail.variable2 + port standard mandatory A port variable with default value. + Default: 8080 + rougail.variable3 + port standard mandatory A port variable with integer default + value. + Default: 8080 + diff --git a/tests/docs/base/00_6regexp.adoc b/tests/results/test_namespace/00_6regexp.adoc similarity index 66% rename from tests/docs/base/00_6regexp.adoc rename to tests/results/test_namespace/00_6regexp.adoc index a10d1f4..b19b5a9 100644 --- a/tests/docs/base/00_6regexp.adoc +++ b/tests/results/test_namespace/00_6regexp.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: a first variable - regexp: ^#(?:[0-9a-f]{3}){1,2}$ - default: '#a1a1a1' - test: - - '#b1b1b1' - - '#b2b2b2' ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6regexp.json b/tests/results/test_namespace/00_6regexp.json similarity index 100% rename from tests/docs/base/00_6regexp.json rename to tests/results/test_namespace/00_6regexp.json diff --git a/tests/results/test_namespace/00_6regexp.md b/tests/results/test_namespace/00_6regexp.md new file mode 100644 index 0000000..f06abb8 --- /dev/null +++ b/tests/results/test_namespace/00_6regexp.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | + diff --git a/tests/results/test_namespace/00_6regexp.sh b/tests/results/test_namespace/00_6regexp.sh new file mode 100644 index 0000000..3ecf5a0 --- /dev/null +++ b/tests/results/test_namespace/00_6regexp.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + regexp standard mandatory A first variable. + Validator: text based with regular + expressions "^#(?:[0-9a-f]{3}){1,2}$" + Default: #a1a1a1 + Examples: + + + • #b1b1b1 + • #b2b2b2 + | diff --git a/tests/docs/base/00_6string.adoc b/tests/results/test_namespace/00_6string.adoc similarity index 76% rename from tests/docs/base/00_6string.adoc rename to tests/results/test_namespace/00_6string.adoc index 7fd0754..9904afc 100644 --- a/tests/docs/base/00_6string.adoc +++ b/tests/results/test_namespace/00_6string.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # the first variable -var2: - description: the second variable - default: -var3: - description: the third variable - type: string -var4: value # the forth variable -var5: - description: the fifth variable - default: value -var6: - description: the sixth variable - type: string - default: value ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_6string.json b/tests/results/test_namespace/00_6string.json similarity index 100% rename from tests/docs/base/00_6string.json rename to tests/results/test_namespace/00_6string.json diff --git a/tests/results/test_namespace/00_6string.md b/tests/results/test_namespace/00_6string.md new file mode 100644 index 0000000..7f09867 --- /dev/null +++ b/tests/results/test_namespace/00_6string.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/docs/base/00_6string.sh b/tests/results/test_namespace/00_6string.sh similarity index 58% rename from tests/docs/base/00_6string.sh rename to tests/results/test_namespace/00_6string.sh index 985b411..cb7b628 100644 --- a/tests/docs/base/00_6string.sh +++ b/tests/results/test_namespace/00_6string.sh @@ -1,27 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable -var2: - description: the second variable - default: -var3: - description: the third variable - type: string -var4: value # the forth variable -var5: - description: the fifth variable - default: value -var6: - description: the sixth variable - type: string - default: value -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ diff --git a/tests/docs/base/00_7choice_quote.adoc b/tests/results/test_namespace/00_7choice_quote.adoc similarity index 62% rename from tests/docs/base/00_7choice_quote.adoc rename to tests/results/test_namespace/00_7choice_quote.adoc index 7784a1b..58b88df 100644 --- a/tests/docs/base/00_7choice_quote.adoc +++ b/tests/results/test_namespace/00_7choice_quote.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var: - type: choice - description: A choice - default: quote' - choices: - - quote' - - quote" - - quote"' ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7choice_quote.json b/tests/results/test_namespace/00_7choice_quote.json similarity index 100% rename from tests/docs/base/00_7choice_quote.json rename to tests/results/test_namespace/00_7choice_quote.json diff --git a/tests/results/test_namespace/00_7choice_quote.md b/tests/results/test_namespace/00_7choice_quote.md new file mode 100644 index 0000000..fbbec0f --- /dev/null +++ b/tests/results/test_namespace/00_7choice_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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"' | + diff --git a/tests/results/test_namespace/00_7choice_quote.sh b/tests/results/test_namespace/00_7choice_quote.sh new file mode 100644 index 0000000..b6f9937 --- /dev/null +++ b/tests/results/test_namespace/00_7choice_quote.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A choice. + Choices: + + + • quote' ← (default) + • quote" + • quote"' + | diff --git a/tests/docs/base/00_7help_quote.adoc b/tests/results/test_namespace/00_7help_quote.adoc similarity index 70% rename from tests/docs/base/00_7help_quote.adoc rename to tests/results/test_namespace/00_7help_quote.adoc index 4475950..84ef0e5 100644 --- a/tests/docs/base/00_7help_quote.adoc +++ b/tests/results/test_namespace/00_7help_quote.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var1: - description: the first variable - help: message with ' -var2: - description: the second variable - help: message with " ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7help_quote.json b/tests/results/test_namespace/00_7help_quote.json similarity index 100% rename from tests/docs/base/00_7help_quote.json rename to tests/results/test_namespace/00_7help_quote.json diff --git a/tests/results/test_namespace/00_7help_quote.md b/tests/results/test_namespace/00_7help_quote.md new file mode 100644 index 0000000..df8f6ec --- /dev/null +++ b/tests/results/test_namespace/00_7help_quote.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 ". | + diff --git a/tests/results/test_namespace/00_7help_quote.sh b/tests/results/test_namespace/00_7help_quote.sh new file mode 100644 index 0000000..271846a --- /dev/null +++ b/tests/results/test_namespace/00_7help_quote.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory The first variable. + Message with '. + rougail.var2 + string basic mandatory The second variable. + Message with ". + diff --git a/tests/docs/base/00_7value_doublequote.adoc b/tests/results/test_namespace/00_7value_doublequote.adoc similarity index 68% rename from tests/docs/base/00_7value_doublequote.adoc rename to tests/results/test_namespace/00_7value_doublequote.adoc index 08da4d4..4524deb 100644 --- a/tests/docs/base/00_7value_doublequote.adoc +++ b/tests/results/test_namespace/00_7value_doublequote.adoc @@ -1,13 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: quote" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7value_doublequote.json b/tests/results/test_namespace/00_7value_doublequote.json similarity index 100% rename from tests/docs/base/00_7value_doublequote.json rename to tests/results/test_namespace/00_7value_doublequote.json diff --git a/tests/results/test_namespace/00_7value_doublequote.md b/tests/results/test_namespace/00_7value_doublequote.md new file mode 100644 index 0000000..673a6b6 --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | + diff --git a/tests/results/test_namespace/00_7value_doublequote.sh b/tests/results/test_namespace/00_7value_doublequote.sh new file mode 100644 index 0000000..be4964c --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote" + diff --git a/tests/docs/base/00_7value_doublequote2.adoc b/tests/results/test_namespace/00_7value_doublequote2.adoc similarity index 68% rename from tests/docs/base/00_7value_doublequote2.adoc rename to tests/results/test_namespace/00_7value_doublequote2.adoc index b760514..1aea3f8 100644 --- a/tests/docs/base/00_7value_doublequote2.adoc +++ b/tests/results/test_namespace/00_7value_doublequote2.adoc @@ -1,13 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: quote'" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7value_doublequote2.json b/tests/results/test_namespace/00_7value_doublequote2.json similarity index 100% rename from tests/docs/base/00_7value_doublequote2.json rename to tests/results/test_namespace/00_7value_doublequote2.json diff --git a/tests/results/test_namespace/00_7value_doublequote2.md b/tests/results/test_namespace/00_7value_doublequote2.md new file mode 100644 index 0000000..97b70da --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | + diff --git a/tests/results/test_namespace/00_7value_doublequote2.sh b/tests/results/test_namespace/00_7value_doublequote2.sh new file mode 100644 index 0000000..55490d8 --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote2.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote'" + diff --git a/tests/docs/base/00_7value_doublequote3.adoc b/tests/results/test_namespace/00_7value_doublequote3.adoc similarity index 68% rename from tests/docs/base/00_7value_doublequote3.adoc rename to tests/results/test_namespace/00_7value_doublequote3.adoc index 9329142..37bf59e 100644 --- a/tests/docs/base/00_7value_doublequote3.adoc +++ b/tests/results/test_namespace/00_7value_doublequote3.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -variable: - description: a variable - default: quote\"\' ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7value_doublequote3.json b/tests/results/test_namespace/00_7value_doublequote3.json similarity index 100% rename from tests/docs/base/00_7value_doublequote3.json rename to tests/results/test_namespace/00_7value_doublequote3.json diff --git a/tests/results/test_namespace/00_7value_doublequote3.md b/tests/results/test_namespace/00_7value_doublequote3.md new file mode 100644 index 0000000..d4d7e65 --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote3.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | + diff --git a/tests/results/test_namespace/00_7value_doublequote3.sh b/tests/results/test_namespace/00_7value_doublequote3.sh new file mode 100644 index 0000000..da920d1 --- /dev/null +++ b/tests/results/test_namespace/00_7value_doublequote3.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote"' + diff --git a/tests/docs/base/00_7value_quote.adoc b/tests/results/test_namespace/00_7value_quote.adoc similarity index 68% rename from tests/docs/base/00_7value_quote.adoc rename to tests/results/test_namespace/00_7value_quote.adoc index 0a7a1aa..04ba785 100644 --- a/tests/docs/base/00_7value_quote.adoc +++ b/tests/results/test_namespace/00_7value_quote.adoc @@ -1,13 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -variable: - description: a variable - default: quote' ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_7value_quote.json b/tests/results/test_namespace/00_7value_quote.json similarity index 100% rename from tests/docs/base/00_7value_quote.json rename to tests/results/test_namespace/00_7value_quote.json diff --git a/tests/results/test_namespace/00_7value_quote.md b/tests/results/test_namespace/00_7value_quote.md new file mode 100644 index 0000000..68eff9f --- /dev/null +++ b/tests/results/test_namespace/00_7value_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | + diff --git a/tests/results/test_namespace/00_7value_quote.sh b/tests/results/test_namespace/00_7value_quote.sh new file mode 100644 index 0000000..3c74205 --- /dev/null +++ b/tests/results/test_namespace/00_7value_quote.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: quote' + diff --git a/tests/results/test_namespace/00_8calculation_information.adoc b/tests/results/test_namespace/00_8calculation_information.adoc new file mode 100644 index 0000000..efe7ce0 --- /dev/null +++ b/tests/results/test_namespace/00_8calculation_information.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get information test_information. +|==== + diff --git a/tests/docs/base/00_8calculation_information.json b/tests/results/test_namespace/00_8calculation_information.json similarity index 100% rename from tests/docs/base/00_8calculation_information.json rename to tests/results/test_namespace/00_8calculation_information.json diff --git a/tests/results/test_namespace/00_8calculation_information.md b/tests/results/test_namespace/00_8calculation_information.md new file mode 100644 index 0000000..7e9bb25 --- /dev/null +++ b/tests/results/test_namespace/00_8calculation_information.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/00_8calculation_information.sh b/tests/results/test_namespace/00_8calculation_information.sh new file mode 100644 index 0000000..bf31add --- /dev/null +++ b/tests/results/test_namespace/00_8calculation_information.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: get information + test_information. + diff --git a/tests/docs/base/00_8test.adoc b/tests/results/test_namespace/00_8test.adoc similarity index 71% rename from tests/docs/base/00_8test.adoc rename to tests/results/test_namespace/00_8test.adoc index 297737f..df8f230 100644 --- a/tests/docs/base/00_8test.adoc +++ b/tests/results/test_namespace/00_8test.adoc @@ -1,48 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var1: - description: the first variable - test: - - test - -var2: - description: the second variable - test: - - test - default: value - -var3: - description: the third variable - test: - - test1 - - test2 - -var4: - description: the forth variable - test: - - - - test1 - - test2 - mandatory: false - -var5: - description: the fifth variable - type: boolean - test: - - false - -var6: - description: the sixth variable - multi: true - test: - - test1 - - test2 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_8test.json b/tests/results/test_namespace/00_8test.json similarity index 100% rename from tests/docs/base/00_8test.json rename to tests/results/test_namespace/00_8test.json diff --git a/tests/results/test_namespace/00_8test.md b/tests/results/test_namespace/00_8test.md new file mode 100644 index 0000000..50bc77d --- /dev/null +++ b/tests/results/test_namespace/00_8test.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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.
**Examples**:
- test1
- test2 | +| **rougail.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | The forth variable.
**Examples**:
- null
- test1
- test2 | +| **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | +| **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | + diff --git a/tests/results/test_namespace/00_8test.sh b/tests/results/test_namespace/00_8test.sh new file mode 100644 index 0000000..626bcea --- /dev/null +++ b/tests/results/test_namespace/00_8test.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory The first variable. + Example: test + rougail.var2 + string standard mandatory The second variable. + Default: value + Example: test + rougail.var3 + string basic mandatory The third variable. + Examples: + + + • test1 + • test2 + | | rougail.var4 string standard + | The forth variable. Examples: + • null + • test1 + • test2 + | | rougail.var5 boolean standard mandatory + | The fifth variable. Default: true Example: false + | | rougail.var6 string basic mandatory unique multiple + | The sixth variable. Examples: + • test1 + • test2 + | diff --git a/tests/docs/base/00_9choice_variable_multi.adoc b/tests/results/test_namespace/00_9choice_variable_multi.adoc similarity index 63% rename from tests/docs/base/00_9choice_variable_multi.adoc rename to tests/results/test_namespace/00_9choice_variable_multi.adoc index c6e353d..a9ebdaf 100644 --- a/tests/docs/base/00_9choice_variable_multi.adoc +++ b/tests/results/test_namespace/00_9choice_variable_multi.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable1: - description: a first variable - type: choice - multi: true - choices: - - val1 - - val2 -variable2: - description: a second variable - type: choice - multi: true - mandatory: false - choices: - - val1 - - val2 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9choice_variable_multi.json b/tests/results/test_namespace/00_9choice_variable_multi.json similarity index 100% rename from tests/docs/base/00_9choice_variable_multi.json rename to tests/results/test_namespace/00_9choice_variable_multi.json diff --git a/tests/results/test_namespace/00_9choice_variable_multi.md b/tests/results/test_namespace/00_9choice_variable_multi.md new file mode 100644 index 0000000..d838db7 --- /dev/null +++ b/tests/results/test_namespace/00_9choice_variable_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_9choice_variable_multi.sh b/tests/results/test_namespace/00_9choice_variable_multi.sh new file mode 100644 index 0000000..184aa58 --- /dev/null +++ b/tests/results/test_namespace/00_9choice_variable_multi.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + choice basic mandatory unique A first variable. + multiple + Choices: + + + • val1 + • val2 + | | rougail.variable2 choice standard unique multiple + | A second variable. Choices: + • val1 + • val2 + | diff --git a/tests/docs/base/00_9choice_variables.adoc b/tests/results/test_namespace/00_9choice_variables.adoc similarity index 71% rename from tests/docs/base/00_9choice_variables.adoc rename to tests/results/test_namespace/00_9choice_variables.adoc index 1f093e0..82a1a0b 100644 --- a/tests/docs/base/00_9choice_variables.adoc +++ b/tests/results/test_namespace/00_9choice_variables.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -source_variable_1: val1 # the first source variable -source_variable_2: val2 # the second source variable -my_variable: - description: a variable - type: choice - choices: - - variable: _.source_variable_1 - - variable: _.source_variable_2 - default: val1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9choice_variables.json b/tests/results/test_namespace/00_9choice_variables.json similarity index 100% rename from tests/docs/base/00_9choice_variables.json rename to tests/results/test_namespace/00_9choice_variables.json diff --git a/tests/results/test_namespace/00_9choice_variables.md b/tests/results/test_namespace/00_9choice_variables.md new file mode 100644 index 0000000..9e7a602 --- /dev/null +++ b/tests/results/test_namespace/00_9choice_variables.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_9choice_variables.sh b/tests/results/test_namespace/00_9choice_variables.sh new file mode 100644 index 0000000..322280f --- /dev/null +++ b/tests/results/test_namespace/00_9choice_variables.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.source_variable_1 + string standard mandatory The first source variable. + Default: val1 + rougail.source_variable_2 + string standard mandatory The second source variable. + Default: val2 + rougail.my_variable + choice standard mandatory A variable. + Choices: + + + • the value of the variable "rougail.source_variable_1". + • the value of the variable "rougail.source_variable_2". Default: val1 + | diff --git a/tests/results/test_namespace/00_9default_calculation.adoc b/tests/results/test_namespace/00_9default_calculation.adoc new file mode 100644 index 0000000..7bd1281 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: concat all parameters. +|==== + diff --git a/tests/docs/base/00_9default_calculation.json b/tests/results/test_namespace/00_9default_calculation.json similarity index 100% rename from tests/docs/base/00_9default_calculation.json rename to tests/results/test_namespace/00_9default_calculation.json diff --git a/tests/results/test_namespace/00_9default_calculation.md b/tests/results/test_namespace/00_9default_calculation.md new file mode 100644 index 0000000..c14be84 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: concat all parameters. | + diff --git a/tests/results/test_namespace/00_9default_calculation.sh b/tests/results/test_namespace/00_9default_calculation.sh new file mode 100644 index 0000000..9591cf1 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: concat all parameters. + diff --git a/tests/results/test_namespace/00_9default_calculation_information.adoc b/tests/results/test_namespace/00_9default_calculation_information.adoc new file mode 100644 index 0000000..ab9477d --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_information.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns the information. +|==== + diff --git a/tests/docs/base/00_9default_calculation_information.json b/tests/results/test_namespace/00_9default_calculation_information.json similarity index 100% rename from tests/docs/base/00_9default_calculation_information.json rename to tests/results/test_namespace/00_9default_calculation_information.json diff --git a/tests/results/test_namespace/00_9default_calculation_information.md b/tests/results/test_namespace/00_9default_calculation_information.md new file mode 100644 index 0000000..41cef80 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_information.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | + diff --git a/tests/results/test_namespace/00_9default_calculation_information.sh b/tests/results/test_namespace/00_9default_calculation_information.sh new file mode 100644 index 0000000..9d030c9 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_information.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A variable. + Default: returns the information. + diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.adoc b/tests/results/test_namespace/00_9default_calculation_information_other_variable.adoc similarity index 60% rename from tests/docs/base/00_9default_calculation_information_other_variable.adoc rename to tests/results/test_namespace/00_9default_calculation_information_other_variable.adoc index 9a98c96..74f27a8 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.adoc +++ b/tests/results/test_namespace/00_9default_calculation_information_other_variable.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - jinja: | - {{ information }} - params: - information: - type: information - information: test_information - variable: _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.json b/tests/results/test_namespace/00_9default_calculation_information_other_variable.json similarity index 100% rename from tests/docs/base/00_9default_calculation_information_other_variable.json rename to tests/results/test_namespace/00_9default_calculation_information_other_variable.json diff --git a/tests/results/test_namespace/00_9default_calculation_information_other_variable.md b/tests/results/test_namespace/00_9default_calculation_information_other_variable.md new file mode 100644 index 0000000..961e2a2 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_information_other_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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**: depends on a calculation. | + diff --git a/tests/results/test_namespace/00_9default_calculation_information_other_variable.sh b/tests/results/test_namespace/00_9default_calculation_information_other_variable.sh new file mode 100644 index 0000000..d003b28 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_information_other_variable.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A first variable. + rougail.var2 + string standard mandatory A second variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/00_9default_calculation_multi_optional.adoc b/tests/results/test_namespace/00_9default_calculation_multi_optional.adoc similarity index 68% rename from tests/docs/base/00_9default_calculation_multi_optional.adoc rename to tests/results/test_namespace/00_9default_calculation_multi_optional.adoc index 164e78b..7548017 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional.adoc +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -my_variable: - default: val1 -my_calculated_variable: - multi: true - default: - - variable: _.my_variable - optional: true - - variable: _.my_variable_unexists - optional: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_calculation_multi_optional.json b/tests/results/test_namespace/00_9default_calculation_multi_optional.json similarity index 100% rename from tests/docs/base/00_9default_calculation_multi_optional.json rename to tests/results/test_namespace/00_9default_calculation_multi_optional.json diff --git a/tests/results/test_namespace/00_9default_calculation_multi_optional.md b/tests/results/test_namespace/00_9default_calculation_multi_optional.md new file mode 100644 index 0000000..d7568f2 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | + diff --git a/tests/results/test_namespace/00_9default_calculation_multi_optional.sh b/tests/results/test_namespace/00_9default_calculation_multi_optional.sh new file mode 100644 index 0000000..03d7144 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory My_variable. + Default: val1 + rougail.my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + Default: the value of the variable + "rougail.my_variable". + diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.adoc b/tests/results/test_namespace/00_9default_calculation_multi_optional2.adoc similarity index 68% rename from tests/docs/base/00_9default_calculation_multi_optional2.adoc rename to tests/results/test_namespace/00_9default_calculation_multi_optional2.adoc index 4307f82..7548017 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional2.adoc +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional2.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -my_variable: - default: val1 -my_calculated_variable: - multi: true - default: - - variable: _.my_variable_unexists - optional: true - - variable: _.my_variable - optional: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.json b/tests/results/test_namespace/00_9default_calculation_multi_optional2.json similarity index 100% rename from tests/docs/base/00_9default_calculation_multi_optional2.json rename to tests/results/test_namespace/00_9default_calculation_multi_optional2.json diff --git a/tests/results/test_namespace/00_9default_calculation_multi_optional2.md b/tests/results/test_namespace/00_9default_calculation_multi_optional2.md new file mode 100644 index 0000000..d7568f2 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional2.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | + diff --git a/tests/results/test_namespace/00_9default_calculation_multi_optional2.sh b/tests/results/test_namespace/00_9default_calculation_multi_optional2.sh new file mode 100644 index 0000000..03d7144 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_multi_optional2.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory My_variable. + Default: val1 + rougail.my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + Default: the value of the variable + "rougail.my_variable". + diff --git a/tests/docs/base/00_9default_calculation_optional.adoc b/tests/results/test_namespace/00_9default_calculation_optional.adoc similarity index 64% rename from tests/docs/base/00_9default_calculation_optional.adoc rename to tests/results/test_namespace/00_9default_calculation_optional.adoc index deb25d8..4c9365a 100644 --- a/tests/docs/base/00_9default_calculation_optional.adoc +++ b/tests/results/test_namespace/00_9default_calculation_optional.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -my_calculated_variable: - multi: true - default: - variable: _.my_variable - optional: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_calculation_optional.json b/tests/results/test_namespace/00_9default_calculation_optional.json similarity index 100% rename from tests/docs/base/00_9default_calculation_optional.json rename to tests/results/test_namespace/00_9default_calculation_optional.json diff --git a/tests/docs/base/00_9default_calculation_optional.md b/tests/results/test_namespace/00_9default_calculation_optional.md similarity index 96% rename from tests/docs/base/00_9default_calculation_optional.md rename to tests/results/test_namespace/00_9default_calculation_optional.md index 1a642a6..bb57eb8 100644 --- a/tests/docs/base/00_9default_calculation_optional.md +++ b/tests/results/test_namespace/00_9default_calculation_optional.md @@ -2,17 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/00_9default_calculation_optional.sh b/tests/results/test_namespace/00_9default_calculation_optional.sh new file mode 100644 index 0000000..a9fe30c --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_optional.sh @@ -0,0 +1,12 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_calculated_variable + string standard mandatory unique My_calculated_variable. + multiple + diff --git a/tests/docs/base/00_9default_calculation_optional_exists.adoc b/tests/results/test_namespace/00_9default_calculation_optional_exists.adoc similarity index 72% rename from tests/docs/base/00_9default_calculation_optional_exists.adoc rename to tests/results/test_namespace/00_9default_calculation_optional_exists.adoc index 310e267..90e6262 100644 --- a/tests/docs/base/00_9default_calculation_optional_exists.adoc +++ b/tests/results/test_namespace/00_9default_calculation_optional_exists.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -my_variable: - multi: true - default: - - val1 - - val2 -my_calculated_variable: - multi: true - default: - variable: _.my_variable - optional: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_calculation_optional_exists.json b/tests/results/test_namespace/00_9default_calculation_optional_exists.json similarity index 100% rename from tests/docs/base/00_9default_calculation_optional_exists.json rename to tests/results/test_namespace/00_9default_calculation_optional_exists.json diff --git a/tests/results/test_namespace/00_9default_calculation_optional_exists.md b/tests/results/test_namespace/00_9default_calculation_optional_exists.md new file mode 100644 index 0000000..68e624d --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_optional_exists.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | + diff --git a/tests/results/test_namespace/00_9default_calculation_optional_exists.sh b/tests/results/test_namespace/00_9default_calculation_optional_exists.sh new file mode 100644 index 0000000..6506424 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_optional_exists.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_variable + string standard mandatory unique My_variable. + multiple + Default: + + + • val1 + • val2 + | | rougail.my_calculated_variable string standard mandatory unique multiple + | My_calculated_variable. Default: the value of the variable + "rougail.my_variable". + | diff --git a/tests/results/test_namespace/00_9default_calculation_param_optional.adoc b/tests/results/test_namespace/00_9default_calculation_param_optional.adoc new file mode 100644 index 0000000..ac8c269 --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_param_optional.adoc @@ -0,0 +1,19 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A first variable. + +**Default**: returns a value. +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A second variable. + +**Default**: no +|==== + diff --git a/tests/docs/base/00_9default_calculation_param_optional.json b/tests/results/test_namespace/00_9default_calculation_param_optional.json similarity index 100% rename from tests/docs/base/00_9default_calculation_param_optional.json rename to tests/results/test_namespace/00_9default_calculation_param_optional.json diff --git a/tests/results/test_namespace/00_9default_calculation_param_optional.md b/tests/results/test_namespace/00_9default_calculation_param_optional.md new file mode 100644 index 0000000..c3d983c --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_param_optional.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_9default_calculation_param_optional.sh b/tests/results/test_namespace/00_9default_calculation_param_optional.sh new file mode 100644 index 0000000..b2e4e4f --- /dev/null +++ b/tests/results/test_namespace/00_9default_calculation_param_optional.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard A first variable. + Default: returns a value. + rougail.var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/docs/base/00_9default_information_other_variable.adoc b/tests/results/test_namespace/00_9default_information_other_variable.adoc similarity index 69% rename from tests/docs/base/00_9default_information_other_variable.adoc rename to tests/results/test_namespace/00_9default_information_other_variable.adoc index 6494f0a..31b53dd 100644 --- a/tests/docs/base/00_9default_information_other_variable.adoc +++ b/tests/results/test_namespace/00_9default_information_other_variable.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - type: information - information: test_information - variable: _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_information_other_variable.json b/tests/results/test_namespace/00_9default_information_other_variable.json similarity index 100% rename from tests/docs/base/00_9default_information_other_variable.json rename to tests/results/test_namespace/00_9default_information_other_variable.json diff --git a/tests/results/test_namespace/00_9default_information_other_variable.md b/tests/results/test_namespace/00_9default_information_other_variable.md new file mode 100644 index 0000000..fda791f --- /dev/null +++ b/tests/results/test_namespace/00_9default_information_other_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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**: the value of the information "test_information" of the variable "rougail.var1". | + diff --git a/tests/results/test_namespace/00_9default_information_other_variable.sh b/tests/results/test_namespace/00_9default_information_other_variable.sh new file mode 100644 index 0000000..917e639 --- /dev/null +++ b/tests/results/test_namespace/00_9default_information_other_variable.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory A first variable. + rougail.var2 + string standard mandatory A second variable. + Default: the value of the information + "test_information" of the variable + "rougail.var1". + diff --git a/tests/docs/base/00_9default_integer.adoc b/tests/results/test_namespace/00_9default_integer.adoc similarity index 52% rename from tests/docs/base/00_9default_integer.adoc rename to tests/results/test_namespace/00_9default_integer.adoc index 96c103e..308d3ee 100644 --- a/tests/docs/base/00_9default_integer.adoc +++ b/tests/results/test_namespace/00_9default_integer.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: a variable - default: 9 - choices: - jinja: | - {% for item in trange(0, 10) %} - {{ item }} - {%- endfor %} - return_type: number - description: choice for 0 to 9 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9default_integer.json b/tests/results/test_namespace/00_9default_integer.json similarity index 100% rename from tests/docs/base/00_9default_integer.json rename to tests/results/test_namespace/00_9default_integer.json diff --git a/tests/results/test_namespace/00_9default_integer.md b/tests/results/test_namespace/00_9default_integer.md new file mode 100644 index 0000000..79242b4 --- /dev/null +++ b/tests/results/test_namespace/00_9default_integer.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/00_9default_integer.sh b/tests/results/test_namespace/00_9default_integer.sh new file mode 100644 index 0000000..bcd7749 --- /dev/null +++ b/tests/results/test_namespace/00_9default_integer.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A variable. + Choices: choice for 0 to 9. + Default: 9 + diff --git a/tests/docs/base/00_9extra.adoc b/tests/results/test_namespace/00_9extra.adoc similarity index 67% rename from tests/docs/base/00_9extra.adoc rename to tests/results/test_namespace/00_9extra.adoc index 561f704..0f4b0d9 100644 --- a/tests/docs/base/00_9extra.adoc +++ b/tests/results/test_namespace/00_9extra.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: rougail # a variable ----- -== dictionaries/extra/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: return no ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9extra.json b/tests/results/test_namespace/00_9extra.json similarity index 100% rename from tests/docs/base/00_9extra.json rename to tests/results/test_namespace/00_9extra.json diff --git a/tests/results/test_namespace/00_9extra.md b/tests/results/test_namespace/00_9extra.md new file mode 100644 index 0000000..6439eb2 --- /dev/null +++ b/tests/results/test_namespace/00_9extra.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: rougail | + +# Variables for "extra" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: return no. | + diff --git a/tests/docs/base/16_5redefine_default.sh b/tests/results/test_namespace/00_9extra.sh similarity index 54% rename from tests/docs/base/16_5redefine_default.sh rename to tests/results/test_namespace/00_9extra.sh index ff8f33f..2e22216 100644 --- a/tests/docs/base/16_5redefine_default.sh +++ b/tests/results/test_namespace/00_9extra.sh @@ -1,24 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: no -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: yes -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ @@ -27,5 +9,19 @@ variable: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ rougail.variable string standard mandatory A variable. - Default: yes + Default: rougail + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.variable + string standard mandatory A variable. + Default: return no. diff --git a/tests/docs/base/00_9extra_calculation.adoc b/tests/results/test_namespace/00_9extra_calculation.adoc similarity index 63% rename from tests/docs/base/00_9extra_calculation.adoc rename to tests/results/test_namespace/00_9extra_calculation.adoc index b3f3588..7e92df4 100644 --- a/tests/docs/base/00_9extra_calculation.adoc +++ b/tests/results/test_namespace/00_9extra_calculation.adoc @@ -1,37 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: value # a variable ----- -== dictionaries/extra/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable1: - description: a first variable - default: - variable: rougail.variable -variable2: - description: a second variable - default: - jinja: | - {{ rougail.variable }} - description: copy the value of rougail.variable -variable3: - description: a third variable - default: - jinja: | - {{ variable }} - params: - variable: - variable: rougail.variable - description: copy the value of rougail.variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/00_9extra_calculation.json b/tests/results/test_namespace/00_9extra_calculation.json similarity index 100% rename from tests/docs/base/00_9extra_calculation.json rename to tests/results/test_namespace/00_9extra_calculation.json diff --git a/tests/results/test_namespace/00_9extra_calculation.md b/tests/results/test_namespace/00_9extra_calculation.md new file mode 100644 index 0000000..ea9cb9f --- /dev/null +++ b/tests/results/test_namespace/00_9extra_calculation.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: value | + +# Variables for "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. | + diff --git a/tests/results/test_namespace/00_9extra_calculation.sh b/tests/results/test_namespace/00_9extra_calculation.sh new file mode 100644 index 0000000..904ae70 --- /dev/null +++ b/tests/results/test_namespace/00_9extra_calculation.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: value + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.variable1 + string standard mandatory A first variable. + Default: the value of the variable + "rougail.variable". + extra.variable2 + string standard mandatory A second variable. + Default: copy the value of + rougail.variable. + extra.variable3 + string standard mandatory A third variable. + Default: copy the value of + rougail.variable. + diff --git a/tests/docs/base/01_6boolean_multi.adoc b/tests/results/test_namespace/01_6boolean_multi.adoc similarity index 75% rename from tests/docs/base/01_6boolean_multi.adoc rename to tests/results/test_namespace/01_6boolean_multi.adoc index 0397d31..74c82f5 100644 --- a/tests/docs/base/01_6boolean_multi.adoc +++ b/tests/results/test_namespace/01_6boolean_multi.adoc @@ -1,44 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # the first variable - - true -var2: - description: the second variable - default: - - true -var3: - description: the third variable - type: boolean - default: - - true -var4: # the forth variable - - false -var5: - description: the fifth variable - default: - - false -var6: - description: the sixth variable - type: boolean - default: - - false - -var7: - description: the seventh variable - multi: true - default: - - true -var8: - description: the eighth variable - type: boolean - multi: true - default: - - true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6boolean_multi.json b/tests/results/test_namespace/01_6boolean_multi.json similarity index 100% rename from tests/docs/base/01_6boolean_multi.json rename to tests/results/test_namespace/01_6boolean_multi.json diff --git a/tests/results/test_namespace/01_6boolean_multi.md b/tests/results/test_namespace/01_6boolean_multi.md new file mode 100644 index 0000000..d355628 --- /dev/null +++ b/tests/results/test_namespace/01_6boolean_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/01_6boolean_multi.sh b/tests/results/test_namespace/01_6boolean_multi.sh new file mode 100644 index 0000000..eab8685 --- /dev/null +++ b/tests/results/test_namespace/01_6boolean_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + boolean standard mandatory unique The first variable. + multiple + Default: true + rougail.var2 + boolean standard mandatory unique The second variable. + multiple + Default: true + rougail.var3 + boolean standard mandatory unique The third variable. + multiple + Default: true + rougail.var4 + boolean standard mandatory unique The forth variable. + multiple + Default: false + rougail.var5 + boolean standard mandatory unique The fifth variable. + multiple + Default: false + rougail.var6 + boolean standard mandatory unique The sixth variable. + multiple + Default: false + rougail.var7 + boolean standard mandatory unique The seventh variable. + multiple + Default: true + rougail.var8 + boolean standard mandatory unique The eighth variable. + multiple + Default: true + diff --git a/tests/docs/base/01_6custom_multi.adoc b/tests/results/test_namespace/01_6custom_multi.adoc similarity index 68% rename from tests/docs/base/01_6custom_multi.adoc rename to tests/results/test_namespace/01_6custom_multi.adoc index 5aad39e..c41aa14 100644 --- a/tests/docs/base/01_6custom_multi.adoc +++ b/tests/results/test_namespace/01_6custom_multi.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -custom1: - description: a first custom variable - type: custom - multi: true -custom2: - description: a second custom variable - type: custom - default: - - value ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6custom_multi.json b/tests/results/test_namespace/01_6custom_multi.json similarity index 100% rename from tests/docs/base/01_6custom_multi.json rename to tests/results/test_namespace/01_6custom_multi.json diff --git a/tests/results/test_namespace/01_6custom_multi.md b/tests/results/test_namespace/01_6custom_multi.md new file mode 100644 index 0000000..a331820 --- /dev/null +++ b/tests/results/test_namespace/01_6custom_multi.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/01_6custom_multi.sh b/tests/results/test_namespace/01_6custom_multi.sh new file mode 100644 index 0000000..94d313a --- /dev/null +++ b/tests/results/test_namespace/01_6custom_multi.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.custom1 + custom basic mandatory unique A first custom variable. + multiple + rougail.custom2 + custom standard mandatory unique A second custom variable. + multiple + Default: value + diff --git a/tests/docs/base/01_6float_multi.adoc b/tests/results/test_namespace/01_6float_multi.adoc similarity index 75% rename from tests/docs/base/01_6float_multi.adoc rename to tests/results/test_namespace/01_6float_multi.adoc index 3b46081..a73e538 100644 --- a/tests/docs/base/01_6float_multi.adoc +++ b/tests/results/test_namespace/01_6float_multi.adoc @@ -1,44 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # the first variable - - 0.0 -var2: - description: the second variable - default: - - 0.0 -var3: - description: the third variable - type: float - default: - - 0.0 -var4: # the forth variable - - 10.1 -var5: - description: the fifth variable - default: - - 10.1 -var6: - description: the sixth variable - type: float - default: - - 10.1 - -var7: - description: the seventh variable - multi: true - default: - - 0.0 -var8: - description: the eighth variable - type: float - multi: true - default: - - 0.0 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6float_multi.json b/tests/results/test_namespace/01_6float_multi.json similarity index 100% rename from tests/docs/base/01_6float_multi.json rename to tests/results/test_namespace/01_6float_multi.json diff --git a/tests/results/test_namespace/01_6float_multi.md b/tests/results/test_namespace/01_6float_multi.md new file mode 100644 index 0000000..1a89de0 --- /dev/null +++ b/tests/results/test_namespace/01_6float_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/01_6float_multi.sh b/tests/results/test_namespace/01_6float_multi.sh new file mode 100644 index 0000000..e1b7270 --- /dev/null +++ b/tests/results/test_namespace/01_6float_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + float standard mandatory unique The first variable. + multiple + Default: 0.0 + rougail.var2 + float standard mandatory unique The second variable. + multiple + Default: 0.0 + rougail.var3 + float standard mandatory unique The third variable. + multiple + Default: 0.0 + rougail.var4 + float standard mandatory unique The forth variable. + multiple + Default: 10.1 + rougail.var5 + float standard mandatory unique The fifth variable. + multiple + Default: 10.1 + rougail.var6 + float standard mandatory unique The sixth variable. + multiple + Default: 10.1 + rougail.var7 + float standard mandatory unique The seventh variable. + multiple + Default: 0.0 + rougail.var8 + float standard mandatory unique The eighth variable. + multiple + Default: 0.0 + diff --git a/tests/docs/base/01_6number_multi.adoc b/tests/results/test_namespace/01_6number_multi.adoc similarity index 75% rename from tests/docs/base/01_6number_multi.adoc rename to tests/results/test_namespace/01_6number_multi.adoc index b3dc40d..9413a75 100644 --- a/tests/docs/base/01_6number_multi.adoc +++ b/tests/results/test_namespace/01_6number_multi.adoc @@ -1,44 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # the first variable - - 0 -var2: - description: the second variable - default: - - 0 -var3: - description: the third variable - type: number - default: - - 0 -var4: # the forth variable - - 10 -var5: - description: the fifth variable - default: - - 10 -var6: - description: the sixth variable - type: number - default: - - 10 - -var7: - description: the seventh variable - multi: true - default: - - 0 -var8: - description: the eighth variable - type: number - multi: true - default: - - 0 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6number_multi.json b/tests/results/test_namespace/01_6number_multi.json similarity index 100% rename from tests/docs/base/01_6number_multi.json rename to tests/results/test_namespace/01_6number_multi.json diff --git a/tests/results/test_namespace/01_6number_multi.md b/tests/results/test_namespace/01_6number_multi.md new file mode 100644 index 0000000..e5b222b --- /dev/null +++ b/tests/results/test_namespace/01_6number_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/01_6number_multi.sh b/tests/results/test_namespace/01_6number_multi.sh new file mode 100644 index 0000000..3356280 --- /dev/null +++ b/tests/results/test_namespace/01_6number_multi.sh @@ -0,0 +1,56 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + number standard mandatory unique The first variable. + multiple + Default: 0 + rougail.var2 + number standard mandatory unique The second variable. + multiple + Default: 0 + rougail.var3 + number standard mandatory unique The third variable. + multiple + Default: 0 + rougail.var4 + number standard mandatory unique The forth variable. + multiple + Default: 10 + rougail.var5 + number standard mandatory unique The fifth variable. + multiple + Default: 10 + rougail.var6 + number standard mandatory unique The sixth variable. + multiple + Default: 10 + rougail.var7 + number standard mandatory unique The seventh variable. + multiple + Default: 0 + rougail.var8 + number standard mandatory unique The eighth variable. + multiple + Default: 0 + diff --git a/tests/docs/base/01_6string_empty.adoc b/tests/results/test_namespace/01_6string_empty.adoc similarity index 66% rename from tests/docs/base/01_6string_empty.adoc rename to tests/results/test_namespace/01_6string_empty.adoc index b0a4ab4..a06e3c1 100644 --- a/tests/docs/base/01_6string_empty.adoc +++ b/tests/results/test_namespace/01_6string_empty.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: the second variable - empty: false - default: - - value - - ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6string_empty.json b/tests/results/test_namespace/01_6string_empty.json similarity index 100% rename from tests/docs/base/01_6string_empty.json rename to tests/results/test_namespace/01_6string_empty.json diff --git a/tests/results/test_namespace/01_6string_empty.md b/tests/results/test_namespace/01_6string_empty.md new file mode 100644 index 0000000..c0e40fb --- /dev/null +++ b/tests/results/test_namespace/01_6string_empty.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | + diff --git a/tests/results/test_namespace/01_6string_empty.sh b/tests/results/test_namespace/01_6string_empty.sh new file mode 100644 index 0000000..f89dfd0 --- /dev/null +++ b/tests/results/test_namespace/01_6string_empty.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique The second variable. + multiple + Default: + + + • value + • null + | diff --git a/tests/docs/base/01_6string_multi.adoc b/tests/results/test_namespace/01_6string_multi.adoc similarity index 75% rename from tests/docs/base/01_6string_multi.adoc rename to tests/results/test_namespace/01_6string_multi.adoc index dc9e1e5..a3e6c0b 100644 --- a/tests/docs/base/01_6string_multi.adoc +++ b/tests/results/test_namespace/01_6string_multi.adoc @@ -1,40 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: [] # the first variable -var2: - description: the second variable - default: [] -var3: - description: the third variable - type: string -var4: # the forth variable - - value -var5: - description: the fifth variable - default: - - value -var6: - description: the sixth variable - type: string - default: - - value - -var7: - description: the seventh variable - multi: true - default: - - value -var8: - description: the eighth variable - type: string - multi: true - default: - - value ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_6string_multi.json b/tests/results/test_namespace/01_6string_multi.json similarity index 100% rename from tests/docs/base/01_6string_multi.json rename to tests/results/test_namespace/01_6string_multi.json diff --git a/tests/results/test_namespace/01_6string_multi.md b/tests/results/test_namespace/01_6string_multi.md new file mode 100644 index 0000000..a694dbb --- /dev/null +++ b/tests/results/test_namespace/01_6string_multi.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/01_6string_multi.sh b/tests/results/test_namespace/01_6string_multi.sh new file mode 100644 index 0000000..a246d26 --- /dev/null +++ b/tests/results/test_namespace/01_6string_multi.sh @@ -0,0 +1,49 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string basic mandatory unique The first variable. + multiple + rougail.var2 + string basic mandatory unique The second variable. + multiple + rougail.var3 + string basic mandatory The third variable. + rougail.var4 + string standard mandatory unique The forth variable. + multiple + Default: value + rougail.var5 + string standard mandatory unique The fifth variable. + multiple + Default: value + rougail.var6 + string standard mandatory unique The sixth variable. + multiple + Default: value + rougail.var7 + string standard mandatory unique The seventh variable. + multiple + Default: value + rougail.var8 + string standard mandatory unique The eighth variable. + multiple + Default: value + diff --git a/tests/docs/base/01_7value_multi_doublequote.adoc b/tests/results/test_namespace/01_7value_multi_doublequote.adoc similarity index 69% rename from tests/docs/base/01_7value_multi_doublequote.adoc rename to tests/results/test_namespace/01_7value_multi_doublequote.adoc index 4c1c7b3..db3b22c 100644 --- a/tests/docs/base/01_7value_multi_doublequote.adoc +++ b/tests/results/test_namespace/01_7value_multi_doublequote.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - - quote" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_7value_multi_doublequote.json b/tests/results/test_namespace/01_7value_multi_doublequote.json similarity index 100% rename from tests/docs/base/01_7value_multi_doublequote.json rename to tests/results/test_namespace/01_7value_multi_doublequote.json diff --git a/tests/results/test_namespace/01_7value_multi_doublequote.md b/tests/results/test_namespace/01_7value_multi_doublequote.md new file mode 100644 index 0000000..b6c3f41 --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_doublequote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | + diff --git a/tests/results/test_namespace/01_7value_multi_doublequote.sh b/tests/results/test_namespace/01_7value_multi_doublequote.sh new file mode 100644 index 0000000..173c6fe --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_doublequote.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: quote" + diff --git a/tests/docs/base/01_7value_multi_doublequote2.adoc b/tests/results/test_namespace/01_7value_multi_doublequote2.adoc similarity index 69% rename from tests/docs/base/01_7value_multi_doublequote2.adoc rename to tests/results/test_namespace/01_7value_multi_doublequote2.adoc index 33542ec..317e63d 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.adoc +++ b/tests/results/test_namespace/01_7value_multi_doublequote2.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - - quote'" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_7value_multi_doublequote2.json b/tests/results/test_namespace/01_7value_multi_doublequote2.json similarity index 100% rename from tests/docs/base/01_7value_multi_doublequote2.json rename to tests/results/test_namespace/01_7value_multi_doublequote2.json diff --git a/tests/results/test_namespace/01_7value_multi_doublequote2.md b/tests/results/test_namespace/01_7value_multi_doublequote2.md new file mode 100644 index 0000000..018bf7a --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_doublequote2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | + diff --git a/tests/results/test_namespace/01_7value_multi_doublequote2.sh b/tests/results/test_namespace/01_7value_multi_doublequote2.sh new file mode 100644 index 0000000..e6b1ce0 --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_doublequote2.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: quote'" + diff --git a/tests/docs/base/01_7value_multi_quote.adoc b/tests/results/test_namespace/01_7value_multi_quote.adoc similarity index 69% rename from tests/docs/base/01_7value_multi_quote.adoc rename to tests/results/test_namespace/01_7value_multi_quote.adoc index 1a2f6c2..8f7a0af 100644 --- a/tests/docs/base/01_7value_multi_quote.adoc +++ b/tests/results/test_namespace/01_7value_multi_quote.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - - quote' ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_7value_multi_quote.json b/tests/results/test_namespace/01_7value_multi_quote.json similarity index 100% rename from tests/docs/base/01_7value_multi_quote.json rename to tests/results/test_namespace/01_7value_multi_quote.json diff --git a/tests/results/test_namespace/01_7value_multi_quote.md b/tests/results/test_namespace/01_7value_multi_quote.md new file mode 100644 index 0000000..453f5a3 --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_quote.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | + diff --git a/tests/results/test_namespace/01_7value_multi_quote.sh b/tests/results/test_namespace/01_7value_multi_quote.sh new file mode 100644 index 0000000..44625d2 --- /dev/null +++ b/tests/results/test_namespace/01_7value_multi_quote.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: quote' + diff --git a/tests/results/test_namespace/01_8calculation_information_multi.adoc b/tests/results/test_namespace/01_8calculation_information_multi.adoc new file mode 100644 index 0000000..b1119cd --- /dev/null +++ b/tests/results/test_namespace/01_8calculation_information_multi.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: get information test_information. +|==== + diff --git a/tests/docs/base/01_8calculation_information_multi.json b/tests/results/test_namespace/01_8calculation_information_multi.json similarity index 100% rename from tests/docs/base/01_8calculation_information_multi.json rename to tests/results/test_namespace/01_8calculation_information_multi.json diff --git a/tests/results/test_namespace/01_8calculation_information_multi.md b/tests/results/test_namespace/01_8calculation_information_multi.md new file mode 100644 index 0000000..6f2f4af --- /dev/null +++ b/tests/results/test_namespace/01_8calculation_information_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/01_8calculation_information_multi.sh b/tests/results/test_namespace/01_8calculation_information_multi.sh new file mode 100644 index 0000000..6fb458b --- /dev/null +++ b/tests/results/test_namespace/01_8calculation_information_multi.sh @@ -0,0 +1,15 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: get information + test_information. + diff --git a/tests/docs/base/01_9choice_variable_multi.adoc b/tests/results/test_namespace/01_9choice_variable_multi.adoc similarity index 73% rename from tests/docs/base/01_9choice_variable_multi.adoc rename to tests/results/test_namespace/01_9choice_variable_multi.adoc index 0580dd0..922484e 100644 --- a/tests/docs/base/01_9choice_variable_multi.adoc +++ b/tests/results/test_namespace/01_9choice_variable_multi.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable1: # a first variable - - a - - b - - c -variable2: - description: a second variable - choices: - variable: _.variable1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/01_9choice_variable_multi.json b/tests/results/test_namespace/01_9choice_variable_multi.json similarity index 100% rename from tests/docs/base/01_9choice_variable_multi.json rename to tests/results/test_namespace/01_9choice_variable_multi.json diff --git a/tests/docs/base/01_9choice_variable_multi.md b/tests/results/test_namespace/01_9choice_variable_multi.md similarity index 96% rename from tests/docs/base/01_9choice_variable_multi.md rename to tests/results/test_namespace/01_9choice_variable_multi.md index 4a11bfc..f77584e 100644 --- a/tests/docs/base/01_9choice_variable_multi.md +++ b/tests/results/test_namespace/01_9choice_variable_multi.md @@ -2,20 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: # a first variable - - a - - b - - c -variable2: - description: a second variable - choices: - variable: _.variable1 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/01_9choice_variable_multi.sh b/tests/results/test_namespace/01_9choice_variable_multi.sh new file mode 100644 index 0000000..67ff829 --- /dev/null +++ b/tests/results/test_namespace/01_9choice_variable_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable1 + string standard mandatory unique A first variable. + multiple + Default: + + + • a + • b + • c + | | rougail.variable2 choice basic mandatory + | A second variable. Choices: the value of the variable "rougail.variable1". + | diff --git a/tests/docs/base/04_0type_param.adoc b/tests/results/test_namespace/04_0type_param.adoc similarity index 66% rename from tests/docs/base/04_0type_param.adoc rename to tests/results/test_namespace/04_0type_param.adoc index ed266f1..c56ee06 100644 --- a/tests/docs/base/04_0type_param.adoc +++ b/tests/results/test_namespace/04_0type_param.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -int: - description: A limited number - default: 10 - params: - min_number: 0 - max_number: 100 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_0type_param.json b/tests/results/test_namespace/04_0type_param.json similarity index 100% rename from tests/docs/base/04_0type_param.json rename to tests/results/test_namespace/04_0type_param.json diff --git a/tests/results/test_namespace/04_0type_param.md b/tests/results/test_namespace/04_0type_param.md new file mode 100644 index 0000000..7f4b7f2 --- /dev/null +++ b/tests/results/test_namespace/04_0type_param.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | + diff --git a/tests/results/test_namespace/04_0type_param.sh b/tests/results/test_namespace/04_0type_param.sh new file mode 100644 index 0000000..a09d987 --- /dev/null +++ b/tests/results/test_namespace/04_0type_param.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.int + number standard mandatory A limited number. + Validators: + + + • the minimum value is 0 + • the maximum value is 100 Default: 10 + | diff --git a/tests/docs/base/04_1auto_save.adoc b/tests/results/test_namespace/04_1auto_save.adoc similarity index 66% rename from tests/docs/base/04_1auto_save.adoc rename to tests/results/test_namespace/04_1auto_save.adoc index a36bfd0..0230a24 100644 --- a/tests/docs/base/04_1auto_save.adoc +++ b/tests/results/test_namespace/04_1auto_save.adoc @@ -1,14 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -variable: - description: an auto save variable - auto_save: true - default: no ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_1auto_save.json b/tests/results/test_namespace/04_1auto_save.json similarity index 100% rename from tests/docs/base/04_1auto_save.json rename to tests/results/test_namespace/04_1auto_save.json diff --git a/tests/results/test_namespace/04_1auto_save.md b/tests/results/test_namespace/04_1auto_save.md new file mode 100644 index 0000000..49a58f0 --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/04_1auto_save.sh b/tests/results/test_namespace/04_1auto_save.sh new file mode 100644 index 0000000..52d6af2 --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory auto modified An auto save variable. + Default: no + diff --git a/tests/docs/base/04_1auto_save_and_calculated.adoc b/tests/results/test_namespace/04_1auto_save_and_calculated.adoc similarity index 73% rename from tests/docs/base/04_1auto_save_and_calculated.adoc rename to tests/results/test_namespace/04_1auto_save_and_calculated.adoc index 5f22800..5608e02 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.adoc +++ b/tests/results/test_namespace/04_1auto_save_and_calculated.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - auto_save: true - default: - variable: _.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_1auto_save_and_calculated.json b/tests/results/test_namespace/04_1auto_save_and_calculated.json similarity index 100% rename from tests/docs/base/04_1auto_save_and_calculated.json rename to tests/results/test_namespace/04_1auto_save_and_calculated.json diff --git a/tests/results/test_namespace/04_1auto_save_and_calculated.md b/tests/results/test_namespace/04_1auto_save_and_calculated.md new file mode 100644 index 0000000..6b1aad0 --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_calculated.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/04_1auto_save_and_calculated.sh b/tests/results/test_namespace/04_1auto_save_and_calculated.sh new file mode 100644 index 0000000..089232c --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_calculated.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string basic mandatory auto modified A second variable. + Default: the value of the variable + "rougail.var1". + diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.adoc similarity index 60% rename from tests/docs/base/04_1auto_save_and_calculated_hidden.adoc rename to tests/results/test_namespace/04_1auto_save_and_calculated_hidden.adoc index 2fb0a2e..bb5e077 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - auto_save: true - hidden: - jinja: | - {% if _.var1 == "yes" %} - _.var1 is yes - {% endif %} - description: only if the variable var1 has value "yes" - default: - jinja: yes - description: the value is always yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.json b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.json similarity index 100% rename from tests/docs/base/04_1auto_save_and_calculated_hidden.json rename to tests/results/test_namespace/04_1auto_save_and_calculated_hidden.json diff --git a/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.md b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.md new file mode 100644 index 0000000..3dde1c0 --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.sh b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.sh new file mode 100644 index 0000000..211f87c --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_calculated_hidden.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string basic mandatory hidden auto  A second variable. + modified + Default: the value is always yes. + Hidden: only if the variable var1 + has value "yes". + diff --git a/tests/results/test_namespace/04_1auto_save_and_hidden.adoc b/tests/results/test_namespace/04_1auto_save_and_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/04_1auto_save_and_hidden.json b/tests/results/test_namespace/04_1auto_save_and_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/04_1auto_save_and_hidden.md b/tests/results/test_namespace/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/04_1auto_save_and_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/04_1auto_save_and_hidden.sh b/tests/results/test_namespace/04_1auto_save_and_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/04_1default_calculation_hidden.adoc b/tests/results/test_namespace/04_1default_calculation_hidden.adoc similarity index 67% rename from tests/docs/base/04_1default_calculation_hidden.adoc rename to tests/results/test_namespace/04_1default_calculation_hidden.adoc index d7c7b2b..185ce63 100644 --- a/tests/docs/base/04_1default_calculation_hidden.adoc +++ b/tests/results/test_namespace/04_1default_calculation_hidden.adoc @@ -1,28 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 - -var1: - description: a first variable - default: value - -var2: - description: a second variable - disabled: - variable: _.var1 - when: value - -var3: - description: a third variable - default: - jinja: | - {% if _.var1 == 'value' or _.var2 == 'blah' %} - value - {% endif %} ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_1default_calculation_hidden.json b/tests/results/test_namespace/04_1default_calculation_hidden.json similarity index 100% rename from tests/docs/base/04_1default_calculation_hidden.json rename to tests/results/test_namespace/04_1default_calculation_hidden.json diff --git a/tests/results/test_namespace/04_1default_calculation_hidden.md b/tests/results/test_namespace/04_1default_calculation_hidden.md new file mode 100644 index 0000000..1a60bab --- /dev/null +++ b/tests/results/test_namespace/04_1default_calculation_hidden.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/04_1default_calculation_hidden.sh b/tests/results/test_namespace/04_1default_calculation_hidden.sh new file mode 100644 index 0000000..385f070 --- /dev/null +++ b/tests/results/test_namespace/04_1default_calculation_hidden.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: value + rougail.var2 + string basic mandatory disabled A second variable. + Disabled: when the variable + "rougail.var1" has the value + "value". + rougail.var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/04_1default_calculation_hidden_2.adoc b/tests/results/test_namespace/04_1default_calculation_hidden_2.adoc similarity index 68% rename from tests/docs/base/04_1default_calculation_hidden_2.adoc rename to tests/results/test_namespace/04_1default_calculation_hidden_2.adoc index db91300..185ce63 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.adoc +++ b/tests/results/test_namespace/04_1default_calculation_hidden_2.adoc @@ -1,28 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 - -var1: - description: a first variable - default: value - -var2: - description: a second variable - disabled: - variable: _.var1 - when: value - -var3: - description: a third variable - default: - jinja: | - {% if _.var2 is propertyerror %} - value - {% endif %} ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_1default_calculation_hidden_2.json b/tests/results/test_namespace/04_1default_calculation_hidden_2.json similarity index 100% rename from tests/docs/base/04_1default_calculation_hidden_2.json rename to tests/results/test_namespace/04_1default_calculation_hidden_2.json diff --git a/tests/results/test_namespace/04_1default_calculation_hidden_2.md b/tests/results/test_namespace/04_1default_calculation_hidden_2.md new file mode 100644 index 0000000..1a60bab --- /dev/null +++ b/tests/results/test_namespace/04_1default_calculation_hidden_2.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/04_1default_calculation_hidden_2.sh b/tests/results/test_namespace/04_1default_calculation_hidden_2.sh new file mode 100644 index 0000000..385f070 --- /dev/null +++ b/tests/results/test_namespace/04_1default_calculation_hidden_2.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: value + rougail.var2 + string basic mandatory disabled A second variable. + Disabled: when the variable + "rougail.var1" has the value + "value". + rougail.var3 + string standard mandatory A third variable. + Default: depends on a calculation. + diff --git a/tests/docs/base/04_5disabled_calculation.adoc b/tests/results/test_namespace/04_5disabled_calculation.adoc similarity index 60% rename from tests/docs/base/04_5disabled_calculation.adoc rename to tests/results/test_namespace/04_5disabled_calculation.adoc index 7e77c63..2fbd91b 100644 --- a/tests/docs/base/04_5disabled_calculation.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation.adoc @@ -1,27 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a conditional variable -variable1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" -variable2: - description: a second variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation.json b/tests/results/test_namespace/04_5disabled_calculation.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation.json rename to tests/results/test_namespace/04_5disabled_calculation.json diff --git a/tests/results/test_namespace/04_5disabled_calculation.md b/tests/results/test_namespace/04_5disabled_calculation.md new file mode 100644 index 0000000..a54f22c --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/04_5disabled_calculation.sh b/tests/results/test_namespace/04_5disabled_calculation.sh new file mode 100644 index 0000000..b7d020e --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A conditional variable. + Default: no + rougail.variable1 + string basic mandatory disabled A first variable. + Disabled: if condition is egal to + "yes". + rougail.variable2 + string basic mandatory disabled A second variable. + Disabled: if condition is egal to + "yes". + diff --git a/tests/docs/base/04_5disabled_calculation_default.adoc b/tests/results/test_namespace/04_5disabled_calculation_default.adoc similarity index 55% rename from tests/docs/base/04_5disabled_calculation_default.adoc rename to tests/results/test_namespace/04_5disabled_calculation_default.adoc index 3541b2e..539d05a 100644 --- a/tests/docs/base/04_5disabled_calculation_default.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_default.adoc @@ -1,38 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -condition: no # a condition - -var1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition - -var2: - description: a second variable - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation_default.json b/tests/results/test_namespace/04_5disabled_calculation_default.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_default.json rename to tests/results/test_namespace/04_5disabled_calculation_default.json diff --git a/tests/results/test_namespace/04_5disabled_calculation_default.md b/tests/results/test_namespace/04_5disabled_calculation_default.md new file mode 100644 index 0000000..674dba4 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_default.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_default.sh b/tests/results/test_namespace/04_5disabled_calculation_default.sh new file mode 100644 index 0000000..07f7b26 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_default.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory disabled A first variable. + Default: the value of condition. + Disabled: if condition is yes. + rougail.var2 + string standard mandatory disabled A second variable. + Default: the value of condition. + Disabled: if condition is yes. + diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional.adoc b/tests/results/test_namespace/04_5disabled_calculation_optional.adoc new file mode 100644 index 0000000..7539117 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_optional.adoc @@ -0,0 +1,25 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A condition. + +**Default**: no +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | +A first variable. + +**Hidden**: calculation from an unknown variable. +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `__hidden__` | +A second variable. + +**Hidden**: calculation from an condition variable. +|==== + diff --git a/tests/docs/base/04_5disabled_calculation_optional.json b/tests/results/test_namespace/04_5disabled_calculation_optional.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_optional.json rename to tests/results/test_namespace/04_5disabled_calculation_optional.json diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional.md b/tests/results/test_namespace/04_5disabled_calculation_optional.md new file mode 100644 index 0000000..fe52513 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_optional.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_optional.sh b/tests/results/test_namespace/04_5disabled_calculation_optional.sh new file mode 100644 index 0000000..5cb000e --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_optional.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard hidden A first variable. + Hidden: calculation from an unknown + variable. + rougail.var2 + string standard hidden A second variable. + Hidden: calculation from an + condition variable. + diff --git a/tests/docs/base/04_5disabled_calculation_variable.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable.adoc similarity index 75% rename from tests/docs/base/04_5disabled_calculation_variable.adoc rename to tests/results/test_namespace/04_5disabled_calculation_variable.adoc index 1cf8039..78bad4c 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_variable.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: false # a condition -variable: - description: a variable - disabled: - variable: _.condition ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation_variable.json b/tests/results/test_namespace/04_5disabled_calculation_variable.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_variable.json rename to tests/results/test_namespace/04_5disabled_calculation_variable.json diff --git a/tests/docs/base/04_5disabled_calculation_variable.md b/tests/results/test_namespace/04_5disabled_calculation_variable.md similarity index 96% rename from tests/docs/base/04_5disabled_calculation_variable.md rename to tests/results/test_namespace/04_5disabled_calculation_variable.md index c705909..0cda2f6 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.md +++ b/tests/results/test_namespace/04_5disabled_calculation_variable.md @@ -2,17 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: false # a condition -variable: - description: a variable - disabled: - variable: _.condition -``` # Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable.sh b/tests/results/test_namespace/04_5disabled_calculation_variable.sh new file mode 100644 index 0000000..ed290ad --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: false + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable + "rougail.condition" has the value + "true". + diff --git a/tests/docs/base/04_5disabled_calculation_variable2.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable2.adoc similarity index 75% rename from tests/docs/base/04_5disabled_calculation_variable2.adoc rename to tests/results/test_namespace/04_5disabled_calculation_variable2.adoc index 0593da8..630d2b7 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_variable2.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: true # a condition -variable: - description: a variable - disabled: - variable: _.condition ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation_variable2.json b/tests/results/test_namespace/04_5disabled_calculation_variable2.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_variable2.json rename to tests/results/test_namespace/04_5disabled_calculation_variable2.json diff --git a/tests/docs/base/04_5disabled_calculation_variable2.md b/tests/results/test_namespace/04_5disabled_calculation_variable2.md similarity index 96% rename from tests/docs/base/04_5disabled_calculation_variable2.md rename to tests/results/test_namespace/04_5disabled_calculation_variable2.md index 725e2bd..8c3fb08 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.md +++ b/tests/results/test_namespace/04_5disabled_calculation_variable2.md @@ -2,17 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -variable: - description: a variable - disabled: - variable: _.condition -``` # Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable2.sh b/tests/results/test_namespace/04_5disabled_calculation_variable2.sh new file mode 100644 index 0000000..3faa1cf --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable2.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable + "rougail.condition" has the value + "true". + diff --git a/tests/docs/base/04_5disabled_calculation_variable3.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable3.adoc similarity index 73% rename from tests/docs/base/04_5disabled_calculation_variable3.adoc rename to tests/results/test_namespace/04_5disabled_calculation_variable3.adoc index 69eb5b1..11eb75b 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_variable3.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when: yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation_variable3.json b/tests/results/test_namespace/04_5disabled_calculation_variable3.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_variable3.json rename to tests/results/test_namespace/04_5disabled_calculation_variable3.json diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable3.md b/tests/results/test_namespace/04_5disabled_calculation_variable3.md new file mode 100644 index 0000000..07eb0e9 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable3.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable3.sh b/tests/results/test_namespace/04_5disabled_calculation_variable3.sh new file mode 100644 index 0000000..6c79d1c --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable3.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable + "rougail.condition" has the value + "yes". + diff --git a/tests/docs/base/04_5disabled_calculation_variable4.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable4.adoc similarity index 73% rename from tests/docs/base/04_5disabled_calculation_variable4.adoc rename to tests/results/test_namespace/04_5disabled_calculation_variable4.adoc index 09a5830..53a9d55 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.adoc +++ b/tests/results/test_namespace/04_5disabled_calculation_variable4.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when_not: yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5disabled_calculation_variable4.json b/tests/results/test_namespace/04_5disabled_calculation_variable4.json similarity index 100% rename from tests/docs/base/04_5disabled_calculation_variable4.json rename to tests/results/test_namespace/04_5disabled_calculation_variable4.json diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable4.md b/tests/results/test_namespace/04_5disabled_calculation_variable4.md new file mode 100644 index 0000000..30eb439 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable4.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable4.sh b/tests/results/test_namespace/04_5disabled_calculation_variable4.sh new file mode 100644 index 0000000..0346623 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable4.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + rougail.variable + string basic mandatory disabled A variable. + Disabled: when the variable + "rougail.condition" hasn't the value + "yes". + diff --git a/tests/docs/base/04_5hidden_calculation.adoc b/tests/results/test_namespace/04_5hidden_calculation.adoc similarity index 60% rename from tests/docs/base/04_5hidden_calculation.adoc rename to tests/results/test_namespace/04_5hidden_calculation.adoc index 788596e..d8fd120 100644 --- a/tests/docs/base/04_5hidden_calculation.adoc +++ b/tests/results/test_namespace/04_5hidden_calculation.adoc @@ -1,29 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # the condition -var1: - description: a first variable - default: no - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -var2: - description: a second variable - default: no - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5hidden_calculation.json b/tests/results/test_namespace/04_5hidden_calculation.json similarity index 100% rename from tests/docs/base/04_5hidden_calculation.json rename to tests/results/test_namespace/04_5hidden_calculation.json diff --git a/tests/results/test_namespace/04_5hidden_calculation.md b/tests/results/test_namespace/04_5hidden_calculation.md new file mode 100644 index 0000000..5987568 --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/04_5hidden_calculation.sh b/tests/results/test_namespace/04_5hidden_calculation.sh new file mode 100644 index 0000000..ed2f94f --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: no + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: no + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5hidden_calculation2.adoc b/tests/results/test_namespace/04_5hidden_calculation2.adoc similarity index 55% rename from tests/docs/base/04_5hidden_calculation2.adoc rename to tests/results/test_namespace/04_5hidden_calculation2.adoc index d8a6291..1f04a5d 100644 --- a/tests/docs/base/04_5hidden_calculation2.adoc +++ b/tests/results/test_namespace/04_5hidden_calculation2.adoc @@ -1,35 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5hidden_calculation2.json b/tests/results/test_namespace/04_5hidden_calculation2.json similarity index 100% rename from tests/docs/base/04_5hidden_calculation2.json rename to tests/results/test_namespace/04_5hidden_calculation2.json diff --git a/tests/results/test_namespace/04_5hidden_calculation2.md b/tests/results/test_namespace/04_5hidden_calculation2.md new file mode 100644 index 0000000..82d6785 --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation2.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/04_5hidden_calculation2.sh b/tests/results/test_namespace/04_5hidden_calculation2.sh new file mode 100644 index 0000000..ab2495b --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation2.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: the value of condition. + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: the value of condition. + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.adoc similarity index 55% rename from tests/docs/base/04_5hidden_calculation_default_calculation.adoc rename to tests/results/test_namespace/04_5hidden_calculation_default_calculation.adoc index f184b66..84734fd 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc +++ b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.adoc @@ -1,35 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: returns the condition value -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: returns the condition value ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.json b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.json similarity index 100% rename from tests/docs/base/04_5hidden_calculation_default_calculation.json rename to tests/results/test_namespace/04_5hidden_calculation_default_calculation.json diff --git a/tests/results/test_namespace/04_5hidden_calculation_default_calculation.md b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.md new file mode 100644 index 0000000..9600f3c --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/04_5hidden_calculation_default_calculation.sh b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.sh new file mode 100644 index 0000000..3509176 --- /dev/null +++ b/tests/results/test_namespace/04_5hidden_calculation_default_calculation.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var1 + string standard mandatory hidden A first variable. + Default: returns the condition value. + Hidden: if condition is yes. + rougail.var2 + string standard mandatory hidden A second variable. + Default: returns the condition value. + Hidden: if condition is yes. + diff --git a/tests/docs/base/04_5validators.adoc b/tests/results/test_namespace/04_5validators.adoc similarity index 52% rename from tests/docs/base/04_5validators.adoc rename to tests/results/test_namespace/04_5validators.adoc index 59eda53..e7f8fb2 100644 --- a/tests/docs/base/04_5validators.adoc +++ b/tests/results/test_namespace/04_5validators.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -int: - description: A number - type: number - validators: - - jinja: | - {% if _.int > 100 %} - value is too high - {% endif %} - description: the max value is 100 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5validators.json b/tests/results/test_namespace/04_5validators.json similarity index 100% rename from tests/docs/base/04_5validators.json rename to tests/results/test_namespace/04_5validators.json diff --git a/tests/results/test_namespace/04_5validators.md b/tests/results/test_namespace/04_5validators.md new file mode 100644 index 0000000..0ff9cee --- /dev/null +++ b/tests/results/test_namespace/04_5validators.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/04_5validators.sh b/tests/results/test_namespace/04_5validators.sh new file mode 100644 index 0000000..39789c1 --- /dev/null +++ b/tests/results/test_namespace/04_5validators.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.int + number basic mandatory A number. + Validator: the max value is 100. + diff --git a/tests/docs/base/04_5validators_differ.adoc b/tests/results/test_namespace/04_5validators_differ.adoc similarity index 59% rename from tests/docs/base/04_5validators_differ.adoc rename to tests/results/test_namespace/04_5validators_differ.adoc index 551b726..ef4fd21 100644 --- a/tests/docs/base/04_5validators_differ.adoc +++ b/tests/results/test_namespace/04_5validators_differ.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: a first variable - test: - - another_value - type: string - default: oui - validators: - - jinja: | - {% if _.var1 == _.var2 %} - var1 must be different than var2 - {% endif %} - description: var1 must be different than var2 -var2: no # A second variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/04_5validators_differ.json b/tests/results/test_namespace/04_5validators_differ.json similarity index 100% rename from tests/docs/base/04_5validators_differ.json rename to tests/results/test_namespace/04_5validators_differ.json diff --git a/tests/results/test_namespace/04_5validators_differ.md b/tests/results/test_namespace/04_5validators_differ.md new file mode 100644 index 0000000..c54b136 --- /dev/null +++ b/tests/results/test_namespace/04_5validators_differ.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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
**Example**: another_value | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | + diff --git a/tests/results/test_namespace/04_5validators_differ.sh b/tests/results/test_namespace/04_5validators_differ.sh new file mode 100644 index 0000000..473bd7e --- /dev/null +++ b/tests/results/test_namespace/04_5validators_differ.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Validator: var1 must be different + than var2. + Default: oui + Example: another_value + rougail.var2 + string standard mandatory A second variable. + Default: no + diff --git a/tests/results/test_namespace/04_5validators_multi.adoc b/tests/results/test_namespace/04_5validators_multi.adoc new file mode 100644 index 0000000..455b4cc --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi.adoc @@ -0,0 +1,17 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 10. + +**Default**: + +* no +* yes +|==== + diff --git a/tests/docs/base/04_5validators_multi.json b/tests/results/test_namespace/04_5validators_multi.json similarity index 100% rename from tests/docs/base/04_5validators_multi.json rename to tests/results/test_namespace/04_5validators_multi.json diff --git a/tests/results/test_namespace/04_5validators_multi.md b/tests/results/test_namespace/04_5validators_multi.md new file mode 100644 index 0000000..2bc7ad2 --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | + diff --git a/tests/results/test_namespace/04_5validators_multi.sh b/tests/results/test_namespace/04_5validators_multi.sh new file mode 100644 index 0000000..24dca2f --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A second variable. + multiple + Validator: check length is less than + 10. + Default: + + + • no + • yes + | diff --git a/tests/results/test_namespace/04_5validators_multi2.adoc b/tests/results/test_namespace/04_5validators_multi2.adoc new file mode 100644 index 0000000..48d620b --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi2.adoc @@ -0,0 +1,22 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A second variable. + +**Validator**: check length is less than 3. + +**Default**: + +* no +* yes + +**Examples**: + +* val1 +* val2 +|==== + diff --git a/tests/docs/base/04_5validators_multi2.json b/tests/results/test_namespace/04_5validators_multi2.json similarity index 100% rename from tests/docs/base/04_5validators_multi2.json rename to tests/results/test_namespace/04_5validators_multi2.json diff --git a/tests/results/test_namespace/04_5validators_multi2.md b/tests/results/test_namespace/04_5validators_multi2.md new file mode 100644 index 0000000..60b44d4 --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi2.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | + diff --git a/tests/results/test_namespace/04_5validators_multi2.sh b/tests/results/test_namespace/04_5validators_multi2.sh new file mode 100644 index 0000000..8b61ee1 --- /dev/null +++ b/tests/results/test_namespace/04_5validators_multi2.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A second variable. + multiple + Validator: check length is less than + 3. + Default: + + + • no + • yes Examples: + • val1 + • val2 + | diff --git a/tests/docs/base/05_0multi_not_uniq.adoc b/tests/results/test_namespace/05_0multi_not_uniq.adoc similarity index 66% rename from tests/docs/base/05_0multi_not_uniq.adoc rename to tests/results/test_namespace/05_0multi_not_uniq.adoc index 39a4551..7d7e2fa 100644 --- a/tests/docs/base/05_0multi_not_uniq.adoc +++ b/tests/results/test_namespace/05_0multi_not_uniq.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: a variable - unique: false - default: - - non ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/05_0multi_not_uniq.json b/tests/results/test_namespace/05_0multi_not_uniq.json similarity index 100% rename from tests/docs/base/05_0multi_not_uniq.json rename to tests/results/test_namespace/05_0multi_not_uniq.json diff --git a/tests/results/test_namespace/05_0multi_not_uniq.md b/tests/results/test_namespace/05_0multi_not_uniq.md new file mode 100644 index 0000000..b3f0870 --- /dev/null +++ b/tests/results/test_namespace/05_0multi_not_uniq.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                              | Description                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test_namespace/05_0multi_not_uniq.sh b/tests/results/test_namespace/05_0multi_not_uniq.sh new file mode 100644 index 0000000..d6fac90 --- /dev/null +++ b/tests/results/test_namespace/05_0multi_not_uniq.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory multiple A variable. + Default: non + diff --git a/tests/docs/base/05_0multi_uniq.adoc b/tests/results/test_namespace/05_0multi_uniq.adoc similarity index 67% rename from tests/docs/base/05_0multi_uniq.adoc rename to tests/results/test_namespace/05_0multi_uniq.adoc index 2d978b8..a410c22 100644 --- a/tests/docs/base/05_0multi_uniq.adoc +++ b/tests/results/test_namespace/05_0multi_uniq.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - unique: true - default: - - non ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/05_0multi_uniq.json b/tests/results/test_namespace/05_0multi_uniq.json similarity index 100% rename from tests/docs/base/05_0multi_uniq.json rename to tests/results/test_namespace/05_0multi_uniq.json diff --git a/tests/results/test_namespace/05_0multi_uniq.md b/tests/results/test_namespace/05_0multi_uniq.md new file mode 100644 index 0000000..71ebea9 --- /dev/null +++ b/tests/results/test_namespace/05_0multi_uniq.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test_namespace/05_0multi_uniq.sh b/tests/results/test_namespace/05_0multi_uniq.sh new file mode 100644 index 0000000..dfcaa51 --- /dev/null +++ b/tests/results/test_namespace/05_0multi_uniq.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: non + diff --git a/tests/docs/base/12_1auto_save_expert.adoc b/tests/results/test_namespace/12_1auto_save_expert.adoc similarity index 65% rename from tests/docs/base/12_1auto_save_expert.adoc rename to tests/results/test_namespace/12_1auto_save_expert.adoc index 202da56..14285a3 100644 --- a/tests/docs/base/12_1auto_save_expert.adoc +++ b/tests/results/test_namespace/12_1auto_save_expert.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var: - description: a variable - auto_save: true - mode: advanced - default: no ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/12_1auto_save_expert.json b/tests/results/test_namespace/12_1auto_save_expert.json similarity index 100% rename from tests/docs/base/12_1auto_save_expert.json rename to tests/results/test_namespace/12_1auto_save_expert.json diff --git a/tests/results/test_namespace/12_1auto_save_expert.md b/tests/results/test_namespace/12_1auto_save_expert.md new file mode 100644 index 0000000..a2bffae --- /dev/null +++ b/tests/results/test_namespace/12_1auto_save_expert.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` `auto modified` | A variable.
**Default**: no | + diff --git a/tests/results/test_namespace/12_1auto_save_expert.sh b/tests/results/test_namespace/12_1auto_save_expert.sh new file mode 100644 index 0000000..10784a6 --- /dev/null +++ b/tests/results/test_namespace/12_1auto_save_expert.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string advanced mandatory auto  A variable. + modified + Default: no + diff --git a/tests/docs/base/16_0redefine_description.adoc b/tests/results/test_namespace/16_0redefine_description.adoc similarity index 50% rename from tests/docs/base/16_0redefine_description.adoc rename to tests/results/test_namespace/16_0redefine_description.adoc index 1fd13e4..15f1127 100644 --- a/tests/docs/base/16_0redefine_description.adoc +++ b/tests/results/test_namespace/16_0redefine_description.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: Redefine description ----- -== dictionaries/rougail/01-redefine.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: Redefined - redefine: true ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_0redefine_description.json b/tests/results/test_namespace/16_0redefine_description.json similarity index 100% rename from tests/docs/base/16_0redefine_description.json rename to tests/results/test_namespace/16_0redefine_description.json diff --git a/tests/results/test_namespace/16_0redefine_description.md b/tests/results/test_namespace/16_0redefine_description.md new file mode 100644 index 0000000..b2064cd --- /dev/null +++ b/tests/results/test_namespace/16_0redefine_description.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Redefined. | + diff --git a/tests/results/test_namespace/16_0redefine_description.sh b/tests/results/test_namespace/16_0redefine_description.sh new file mode 100644 index 0000000..23224e6 --- /dev/null +++ b/tests/results/test_namespace/16_0redefine_description.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory Redefined. + diff --git a/tests/docs/base/16_2family_redefine_calculation.adoc b/tests/results/test_namespace/16_2family_redefine_calculation.adoc similarity index 60% rename from tests/docs/base/16_2family_redefine_calculation.adoc rename to tests/results/test_namespace/16_2family_redefine_calculation.adoc index 55156d4..8db49b7 100644 --- a/tests/docs/base/16_2family_redefine_calculation.adoc +++ b/tests/results/test_namespace/16_2family_redefine_calculation.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.0' -family: - redefine: true - disabled: - jinja: | - true ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -family: - var1: ----- == Variables for "Rougail" === rougail.family diff --git a/tests/docs/base/16_2family_redefine_calculation.json b/tests/results/test_namespace/16_2family_redefine_calculation.json similarity index 100% rename from tests/docs/base/16_2family_redefine_calculation.json rename to tests/results/test_namespace/16_2family_redefine_calculation.json diff --git a/tests/results/test_namespace/16_2family_redefine_calculation.md b/tests/results/test_namespace/16_2family_redefine_calculation.md new file mode 100644 index 0000000..ea56f93 --- /dev/null +++ b/tests/results/test_namespace/16_2family_redefine_calculation.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## rougail.family + +`basic` *`disabled`* + +**Disabled**: depends on a calculation. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var1. | + diff --git a/tests/results/test_namespace/16_2family_redefine_calculation.sh b/tests/results/test_namespace/16_2family_redefine_calculation.sh new file mode 100644 index 0000000..3141080 --- /dev/null +++ b/tests/results/test_namespace/16_2family_redefine_calculation.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.family + +basic disabled + +Disabled: depends on a calculation. + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory Var1. + diff --git a/tests/results/test_namespace/16_2family_redefine_disabled.adoc b/tests/results/test_namespace/16_2family_redefine_disabled.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/16_2family_redefine_disabled.json b/tests/results/test_namespace/16_2family_redefine_disabled.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/16_2family_redefine_disabled.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/16_2family_redefine_disabled.md b/tests/results/test_namespace/16_2family_redefine_disabled.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/16_2family_redefine_disabled.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/16_2family_redefine_disabled.sh b/tests/results/test_namespace/16_2family_redefine_disabled.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/16_5exists_nonexists.adoc b/tests/results/test_namespace/16_5exists_nonexists.adoc similarity index 65% rename from tests/docs/base/16_5exists_nonexists.adoc rename to tests/results/test_namespace/16_5exists_nonexists.adoc index b806a2e..f370787 100644 --- a/tests/docs/base/16_5exists_nonexists.adoc +++ b/tests/results/test_namespace/16_5exists_nonexists.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -var2: - description: a new variable - exists: false - default: yes ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: no # a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_5exists_nonexists.json b/tests/results/test_namespace/16_5exists_nonexists.json similarity index 100% rename from tests/docs/base/16_5exists_nonexists.json rename to tests/results/test_namespace/16_5exists_nonexists.json diff --git a/tests/results/test_namespace/16_5exists_nonexists.md b/tests/results/test_namespace/16_5exists_nonexists.md new file mode 100644 index 0000000..617708b --- /dev/null +++ b/tests/results/test_namespace/16_5exists_nonexists.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/16_5exists_nonexists.sh b/tests/results/test_namespace/16_5exists_nonexists.sh new file mode 100644 index 0000000..dcf0ff2 --- /dev/null +++ b/tests/results/test_namespace/16_5exists_nonexists.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A variable. + Default: no + rougail.var2 + string standard mandatory A new variable. + Default: yes + diff --git a/tests/results/test_namespace/16_5exists_redefine.adoc b/tests/results/test_namespace/16_5exists_redefine.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/16_5exists_redefine.json b/tests/results/test_namespace/16_5exists_redefine.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/16_5exists_redefine.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/16_5exists_redefine.md b/tests/results/test_namespace/16_5exists_redefine.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/16_5exists_redefine.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/16_5exists_redefine.sh b/tests/results/test_namespace/16_5exists_redefine.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/16_5redefine_calculation.adoc b/tests/results/test_namespace/16_5redefine_calculation.adoc new file mode 100644 index 0000000..dad7fa7 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_calculation.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: returns yes. +|==== + diff --git a/tests/docs/base/16_5redefine_calculation.json b/tests/results/test_namespace/16_5redefine_calculation.json similarity index 100% rename from tests/docs/base/16_5redefine_calculation.json rename to tests/results/test_namespace/16_5redefine_calculation.json diff --git a/tests/results/test_namespace/16_5redefine_calculation.md b/tests/results/test_namespace/16_5redefine_calculation.md new file mode 100644 index 0000000..d142738 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + diff --git a/tests/results/test_namespace/16_5redefine_calculation.sh b/tests/results/test_namespace/16_5redefine_calculation.sh new file mode 100644 index 0000000..5d760c4 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_calculation.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: returns yes. + diff --git a/tests/docs/base/16_5redefine_choice.adoc b/tests/results/test_namespace/16_5redefine_choice.adoc similarity index 50% rename from tests/docs/base/16_5redefine_choice.adoc rename to tests/results/test_namespace/16_5redefine_choice.adoc index f4aec74..0a1cb82 100644 --- a/tests/docs/base/16_5redefine_choice.adoc +++ b/tests/results/test_namespace/16_5redefine_choice.adoc @@ -1,28 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - choices: - - a - - b - - c ----- -== dictionaries/rougail/01-redefine.yml - -[,yaml] ----- ---- -version: '1.0' -variable: - redefine: true - choices: - - a - - b ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_5redefine_choice.json b/tests/results/test_namespace/16_5redefine_choice.json similarity index 100% rename from tests/docs/base/16_5redefine_choice.json rename to tests/results/test_namespace/16_5redefine_choice.json diff --git a/tests/results/test_namespace/16_5redefine_choice.md b/tests/results/test_namespace/16_5redefine_choice.md new file mode 100644 index 0000000..992e686 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_choice.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- a
- b | + diff --git a/tests/results/test_namespace/16_5redefine_choice.sh b/tests/results/test_namespace/16_5redefine_choice.sh new file mode 100644 index 0000000..2455cfe --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_choice.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + choice basic mandatory A variable. + Choices: + + + • a + • b + | diff --git a/tests/results/test_namespace/16_5redefine_default.adoc b/tests/results/test_namespace/16_5redefine_default.adoc new file mode 100644 index 0000000..eef2e84 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_default.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: yes +|==== + diff --git a/tests/docs/base/16_5redefine_default.json b/tests/results/test_namespace/16_5redefine_default.json similarity index 100% rename from tests/docs/base/16_5redefine_default.json rename to tests/results/test_namespace/16_5redefine_default.json diff --git a/tests/results/test_namespace/16_5redefine_default.md b/tests/results/test_namespace/16_5redefine_default.md new file mode 100644 index 0000000..21d9760 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_default.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | + diff --git a/tests/results/test_namespace/16_5redefine_default.sh b/tests/results/test_namespace/16_5redefine_default.sh new file mode 100644 index 0000000..596e283 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_default.sh @@ -0,0 +1,13 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory A variable. + Default: yes + diff --git a/tests/docs/base/16_5redefine_default_calculation.adoc b/tests/results/test_namespace/16_5redefine_default_calculation.adoc similarity index 50% rename from tests/docs/base/16_5redefine_default_calculation.adoc rename to tests/results/test_namespace/16_5redefine_default_calculation.adoc index 1614927..6a8b9e2 100644 --- a/tests/docs/base/16_5redefine_default_calculation.adoc +++ b/tests/results/test_namespace/16_5redefine_default_calculation.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - default: ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - description: a variable - default: - jinja: yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_5redefine_default_calculation.json b/tests/results/test_namespace/16_5redefine_default_calculation.json similarity index 100% rename from tests/docs/base/16_5redefine_default_calculation.json rename to tests/results/test_namespace/16_5redefine_default_calculation.json diff --git a/tests/results/test_namespace/16_5redefine_default_calculation.md b/tests/results/test_namespace/16_5redefine_default_calculation.md new file mode 100644 index 0000000..1c87cae --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_default_calculation.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test_namespace/16_5redefine_default_calculation.sh b/tests/results/test_namespace/16_5redefine_default_calculation.sh new file mode 100644 index 0000000..caa8f61 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_default_calculation.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/16_5redefine_family.adoc b/tests/results/test_namespace/16_5redefine_family.adoc similarity index 53% rename from tests/docs/base/16_5redefine_family.adoc rename to tests/results/test_namespace/16_5redefine_family.adoc index ea11686..2a9e9fe 100644 --- a/tests/docs/base/16_5redefine_family.adoc +++ b/tests/results/test_namespace/16_5redefine_family.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - redefine: true - description: new description ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: # a family - variable: # a variable ----- == Variables for "Rougail" === new description diff --git a/tests/docs/base/16_5redefine_family.json b/tests/results/test_namespace/16_5redefine_family.json similarity index 100% rename from tests/docs/base/16_5redefine_family.json rename to tests/results/test_namespace/16_5redefine_family.json diff --git a/tests/results/test_namespace/16_5redefine_family.md b/tests/results/test_namespace/16_5redefine_family.md new file mode 100644 index 0000000..0a5262f --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_family.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test_namespace/16_5redefine_family.sh b/tests/results/test_namespace/16_5redefine_family.sh new file mode 100644 index 0000000..7f013ca --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_family.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string basic mandatory A variable. + diff --git a/tests/results/test_namespace/16_5redefine_help.adoc b/tests/results/test_namespace/16_5redefine_help.adoc new file mode 100644 index 0000000..8cd7e6e --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_help.adoc @@ -0,0 +1,19 @@ +== Variables for "Rougail" + +=== a family + +`basic` + +Redefine help family ok. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.family.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Redefine help. + +Redefine help ok. +|==== + diff --git a/tests/docs/base/16_5redefine_help.json b/tests/results/test_namespace/16_5redefine_help.json similarity index 100% rename from tests/docs/base/16_5redefine_help.json rename to tests/results/test_namespace/16_5redefine_help.json diff --git a/tests/results/test_namespace/16_5redefine_help.md b/tests/results/test_namespace/16_5redefine_help.md new file mode 100644 index 0000000..43d5e54 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_help.md @@ -0,0 +1,16 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a family + +`basic` + +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. | + diff --git a/tests/results/test_namespace/16_5redefine_help.sh b/tests/results/test_namespace/16_5redefine_help.sh new file mode 100644 index 0000000..64585fc --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_help.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + +Redefine help family ok. + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string basic mandatory Redefine help. + Redefine help ok. + diff --git a/tests/results/test_namespace/16_5redefine_hidden.adoc b/tests/results/test_namespace/16_5redefine_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/16_5redefine_hidden.json b/tests/results/test_namespace/16_5redefine_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/16_5redefine_hidden.md b/tests/results/test_namespace/16_5redefine_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/16_5redefine_hidden.sh b/tests/results/test_namespace/16_5redefine_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/16_5redefine_multi.adoc b/tests/results/test_namespace/16_5redefine_multi.adoc new file mode 100644 index 0000000..a410c22 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_multi.adoc @@ -0,0 +1,13 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: non +|==== + diff --git a/tests/docs/base/16_5redefine_multi.json b/tests/results/test_namespace/16_5redefine_multi.json similarity index 100% rename from tests/docs/base/16_5redefine_multi.json rename to tests/results/test_namespace/16_5redefine_multi.json diff --git a/tests/results/test_namespace/16_5redefine_multi.md b/tests/results/test_namespace/16_5redefine_multi.md new file mode 100644 index 0000000..71ebea9 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_multi.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + diff --git a/tests/results/test_namespace/16_5redefine_multi.sh b/tests/results/test_namespace/16_5redefine_multi.sh new file mode 100644 index 0000000..dfcaa51 --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_multi.sh @@ -0,0 +1,14 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string standard mandatory unique A variable. + multiple + Default: non + diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.adoc similarity index 54% rename from tests/docs/base/16_5redefine_remove_disable_calculation.adoc rename to tests/results/test_namespace/16_5redefine_remove_disable_calculation.adoc index 05656df..3c76ef8 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc +++ b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.adoc @@ -1,30 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: - redefine: true - disabled: false ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -variable: - description: a variable - disabled: - jinja: | - {% if _.condition == "yes" %} - true - {% else %} - false - {% endif %} ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.json b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.json similarity index 100% rename from tests/docs/base/16_5redefine_remove_disable_calculation.json rename to tests/results/test_namespace/16_5redefine_remove_disable_calculation.json diff --git a/tests/results/test_namespace/16_5redefine_remove_disable_calculation.md b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.md new file mode 100644 index 0000000..9da9b0f --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/16_5redefine_remove_disable_calculation.sh b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.sh new file mode 100644 index 0000000..1ef13de --- /dev/null +++ b/tests/results/test_namespace/16_5redefine_remove_disable_calculation.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/16_5test_redefine.adoc b/tests/results/test_namespace/16_5test_redefine.adoc similarity index 61% rename from tests/docs/base/16_5test_redefine.adoc rename to tests/results/test_namespace/16_5test_redefine.adoc index c6398d7..b6af6f3 100644 --- a/tests/docs/base/16_5test_redefine.adoc +++ b/tests/results/test_namespace/16_5test_redefine.adoc @@ -1,38 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - test: - - test - default: non -var3: - description: a third variable - test: - - test ----- -== dictionaries/rougail/10-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - redefine: true - test: - - test1 -var2: - redefine: true - test: - - test1 -var3: - redefine: true - test: ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_5test_redefine.json b/tests/results/test_namespace/16_5test_redefine.json similarity index 100% rename from tests/docs/base/16_5test_redefine.json rename to tests/results/test_namespace/16_5test_redefine.json diff --git a/tests/results/test_namespace/16_5test_redefine.md b/tests/results/test_namespace/16_5test_redefine.md new file mode 100644 index 0000000..06e8ce1 --- /dev/null +++ b/tests/results/test_namespace/16_5test_redefine.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/docs/base/16_5test_redefine.sh b/tests/results/test_namespace/16_5test_redefine.sh similarity index 51% rename from tests/docs/base/16_5test_redefine.sh rename to tests/results/test_namespace/16_5test_redefine.sh index d1bbf5c..a83784c 100644 --- a/tests/docs/base/16_5test_redefine.sh +++ b/tests/results/test_namespace/16_5test_redefine.sh @@ -1,39 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - test: - - test - default: non -var3: - description: a third variable - test: - - test -``` -# dictionaries/rougail/10-base.yml - -```yaml ---- -version: '1.1' -var1: - redefine: true - test: - - test1 -var2: - redefine: true - test: - - test1 -var3: - redefine: true - test: -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ diff --git a/tests/docs/base/16_6choice_redefine.adoc b/tests/results/test_namespace/16_6choice_redefine.adoc similarity index 50% rename from tests/docs/base/16_6choice_redefine.adoc rename to tests/results/test_namespace/16_6choice_redefine.adoc index 97cfb6c..86eae53 100644 --- a/tests/docs/base/16_6choice_redefine.adoc +++ b/tests/results/test_namespace/16_6choice_redefine.adoc @@ -1,30 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.0' -var: - redefine: true - choices: - - a - - c ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var: - type: choice - description: A choice - default: c - choices: - - a - - b - - c ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16_6choice_redefine.json b/tests/results/test_namespace/16_6choice_redefine.json similarity index 100% rename from tests/docs/base/16_6choice_redefine.json rename to tests/results/test_namespace/16_6choice_redefine.json diff --git a/tests/results/test_namespace/16_6choice_redefine.md b/tests/results/test_namespace/16_6choice_redefine.md new file mode 100644 index 0000000..d7db144 --- /dev/null +++ b/tests/results/test_namespace/16_6choice_redefine.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | + diff --git a/tests/results/test_namespace/16_6choice_redefine.sh b/tests/results/test_namespace/16_6choice_redefine.sh new file mode 100644 index 0000000..d3e86af --- /dev/null +++ b/tests/results/test_namespace/16_6choice_redefine.sh @@ -0,0 +1,17 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + choice standard mandatory A choice. + Choices: + + + • a + • c ← (default) + | diff --git a/tests/results/test_namespace/16_6exists_redefine_family.adoc b/tests/results/test_namespace/16_6exists_redefine_family.adoc new file mode 100644 index 0000000..42ba630 --- /dev/null +++ b/tests/results/test_namespace/16_6exists_redefine_family.adoc @@ -0,0 +1,30 @@ +== Variables for "Rougail" + +=== new description + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.family1.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A variable. +|==== + +=== a second family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.family2.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + diff --git a/tests/results/test_namespace/16_6exists_redefine_family.json b/tests/results/test_namespace/16_6exists_redefine_family.json new file mode 100644 index 0000000..5c28ce3 --- /dev/null +++ b/tests/results/test_namespace/16_6exists_redefine_family.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"family1": {"type": "family", "informations": {"paths": ["rougail.family1"], "names": ["family1"], "description": "new description", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family1.variable1"], "names": ["variable1"], "descriptions": ["A variable."]}}}, "family2": {"type": "family", "informations": {"paths": ["rougail.family2"], "names": ["family2"], "description": "a second family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.family2.variable2"], "names": ["variable2"], "descriptions": ["A second variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/16_6exists_redefine_family.md b/tests/results/test_namespace/16_6exists_redefine_family.md new file mode 100644 index 0000000..b3a5032 --- /dev/null +++ b/tests/results/test_namespace/16_6exists_redefine_family.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family1.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a second family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family2.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + diff --git a/tests/results/test_namespace/16_6exists_redefine_family.sh b/tests/results/test_namespace/16_6exists_redefine_family.sh new file mode 100644 index 0000000..62e6b02 --- /dev/null +++ b/tests/results/test_namespace/16_6exists_redefine_family.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + new description + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family1.variable1 + string basic mandatory A variable. + + + + a second family + +basic + + + +  Variable                         Description                     + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family2.variable2 + string basic mandatory A second variable. + diff --git a/tests/docs/base/16exists_exists.adoc b/tests/results/test_namespace/16exists_exists.adoc similarity index 51% rename from tests/docs/base/16exists_exists.adoc rename to tests/results/test_namespace/16exists_exists.adoc index a3f69f1..e1853d3 100644 --- a/tests/docs/base/16exists_exists.adoc +++ b/tests/results/test_namespace/16exists_exists.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: New description - exists: false ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: Description ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/16exists_exists.json b/tests/results/test_namespace/16exists_exists.json similarity index 100% rename from tests/docs/base/16exists_exists.json rename to tests/results/test_namespace/16exists_exists.json diff --git a/tests/results/test_namespace/16exists_exists.md b/tests/results/test_namespace/16exists_exists.md new file mode 100644 index 0000000..b1f0a6b --- /dev/null +++ b/tests/results/test_namespace/16exists_exists.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Description. | + diff --git a/tests/results/test_namespace/16exists_exists.sh b/tests/results/test_namespace/16exists_exists.sh new file mode 100644 index 0000000..1d6097b --- /dev/null +++ b/tests/results/test_namespace/16exists_exists.sh @@ -0,0 +1,11 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory Description. + diff --git a/tests/results/test_namespace/17_5redefine_leadership.adoc b/tests/results/test_namespace/17_5redefine_leadership.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/17_5redefine_leadership.json b/tests/results/test_namespace/17_5redefine_leadership.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/17_5redefine_leadership.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/17_5redefine_leadership.md b/tests/results/test_namespace/17_5redefine_leadership.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/17_5redefine_leadership.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/17_5redefine_leadership.sh b/tests/results/test_namespace/17_5redefine_leadership.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/20_0empty_family.adoc b/tests/results/test_namespace/20_0empty_family.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/20_0empty_family.json b/tests/results/test_namespace/20_0empty_family.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/20_0empty_family.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/20_0empty_family.md b/tests/results/test_namespace/20_0empty_family.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/20_0empty_family.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/20_0empty_family.sh b/tests/results/test_namespace/20_0empty_family.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_0family_append.adoc b/tests/results/test_namespace/20_0family_append.adoc similarity index 62% rename from tests/docs/base/20_0family_append.adoc rename to tests/results/test_namespace/20_0family_append.adoc index 30ba86e..552e7d2 100644 --- a/tests/docs/base/20_0family_append.adoc +++ b/tests/results/test_namespace/20_0family_append.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - var2: - description: The second variable ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - description: A family - var1: - description: The first variable ----- == Variables for "Rougail" === A family diff --git a/tests/docs/base/20_0family_append.json b/tests/results/test_namespace/20_0family_append.json similarity index 100% rename from tests/docs/base/20_0family_append.json rename to tests/results/test_namespace/20_0family_append.json diff --git a/tests/results/test_namespace/20_0family_append.md b/tests/results/test_namespace/20_0family_append.md new file mode 100644 index 0000000..9ed8b4b --- /dev/null +++ b/tests/results/test_namespace/20_0family_append.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/20_0family_append.sh b/tests/results/test_namespace/20_0family_append.sh new file mode 100644 index 0000000..d2ef80e --- /dev/null +++ b/tests/results/test_namespace/20_0family_append.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory The first variable. + rougail.family.var2 + string basic mandatory The second variable. + diff --git a/tests/results/test_namespace/20_0family_underscore.adoc b/tests/results/test_namespace/20_0family_underscore.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/20_0family_underscore.json b/tests/results/test_namespace/20_0family_underscore.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/20_0family_underscore.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/20_0family_underscore.md b/tests/results/test_namespace/20_0family_underscore.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/20_0family_underscore.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/20_0family_underscore.sh b/tests/results/test_namespace/20_0family_underscore.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_0multi_family.adoc b/tests/results/test_namespace/20_0multi_family.adoc similarity index 62% rename from tests/docs/base/20_0multi_family.adoc rename to tests/results/test_namespace/20_0multi_family.adoc index 0765f7d..7f39543 100644 --- a/tests/docs/base/20_0multi_family.adoc +++ b/tests/results/test_namespace/20_0multi_family.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: - description: a variable - mandatory: false ----- == Variables for "Rougail" === a family diff --git a/tests/docs/base/20_0multi_family.json b/tests/results/test_namespace/20_0multi_family.json similarity index 100% rename from tests/docs/base/20_0multi_family.json rename to tests/results/test_namespace/20_0multi_family.json diff --git a/tests/results/test_namespace/20_0multi_family.md b/tests/results/test_namespace/20_0multi_family.md new file mode 100644 index 0000000..2520ce6 --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a family + +`standard` + +### a sub family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + diff --git a/tests/results/test_namespace/20_0multi_family.sh b/tests/results/test_namespace/20_0multi_family.sh new file mode 100644 index 0000000..1ee9acd --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +standard + + a sub family + +standard + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string standard A variable. + diff --git a/tests/docs/base/20_0multi_family_basic.adoc b/tests/results/test_namespace/20_0multi_family_basic.adoc similarity index 68% rename from tests/docs/base/20_0multi_family_basic.adoc rename to tests/results/test_namespace/20_0multi_family_basic.adoc index 4cd74a5..b010d53 100644 --- a/tests/docs/base/20_0multi_family_basic.adoc +++ b/tests/results/test_namespace/20_0multi_family_basic.adoc @@ -1,13 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: # a variable ----- == Variables for "Rougail" === a family diff --git a/tests/docs/base/20_0multi_family_basic.json b/tests/results/test_namespace/20_0multi_family_basic.json similarity index 100% rename from tests/docs/base/20_0multi_family_basic.json rename to tests/results/test_namespace/20_0multi_family_basic.json diff --git a/tests/docs/base/20_0multi_family_basic.md b/tests/results/test_namespace/20_0multi_family_basic.md similarity index 96% rename from tests/docs/base/20_0multi_family_basic.md rename to tests/results/test_namespace/20_0multi_family_basic.md index 1cfed45..503c67e 100644 --- a/tests/docs/base/20_0multi_family_basic.md +++ b/tests/results/test_namespace/20_0multi_family_basic.md @@ -2,15 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: # a variable -``` # Variables for "Rougail" ## a family diff --git a/tests/results/test_namespace/20_0multi_family_basic.sh b/tests/results/test_namespace/20_0multi_family_basic.sh new file mode 100644 index 0000000..452b899 --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family_basic.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + a sub family + +basic + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string basic mandatory A variable. + diff --git a/tests/docs/base/20_0multi_family_expert.adoc b/tests/results/test_namespace/20_0multi_family_expert.adoc similarity index 59% rename from tests/docs/base/20_0multi_family_expert.adoc rename to tests/results/test_namespace/20_0multi_family_expert.adoc index 2ceead2..16b7204 100644 --- a/tests/docs/base/20_0multi_family_expert.adoc +++ b/tests/results/test_namespace/20_0multi_family_expert.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: - description: a family - mode: advanced - subfamily: # a sub family - variable: - description: a variable - mandatory: false ----- == Variables for "Rougail" === a family diff --git a/tests/docs/base/20_0multi_family_expert.json b/tests/results/test_namespace/20_0multi_family_expert.json similarity index 100% rename from tests/docs/base/20_0multi_family_expert.json rename to tests/results/test_namespace/20_0multi_family_expert.json diff --git a/tests/results/test_namespace/20_0multi_family_expert.md b/tests/results/test_namespace/20_0multi_family_expert.md new file mode 100644 index 0000000..31858c7 --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family_expert.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a family + +`advanced` + +### a sub family + +`advanced` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` | A variable. | + diff --git a/tests/results/test_namespace/20_0multi_family_expert.sh b/tests/results/test_namespace/20_0multi_family_expert.sh new file mode 100644 index 0000000..5f34c57 --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family_expert.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +advanced + + a sub family + +advanced + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string advanced A variable. + diff --git a/tests/docs/base/20_0multi_family_order.adoc b/tests/results/test_namespace/20_0multi_family_order.adoc similarity index 81% rename from tests/docs/base/20_0multi_family_order.adoc rename to tests/results/test_namespace/20_0multi_family_order.adoc index ff7e644..544b59c 100644 --- a/tests/docs/base/20_0multi_family_order.adoc +++ b/tests/results/test_namespace/20_0multi_family_order.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -variable: # a variable -family: # a family - variable1: # a first variable - subfamily: # a sub family - variable: # a variable - variable2: # a second variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/20_0multi_family_order.json b/tests/results/test_namespace/20_0multi_family_order.json similarity index 100% rename from tests/docs/base/20_0multi_family_order.json rename to tests/results/test_namespace/20_0multi_family_order.json diff --git a/tests/docs/base/20_0multi_family_order.md b/tests/results/test_namespace/20_0multi_family_order.md similarity index 98% rename from tests/docs/base/20_0multi_family_order.md rename to tests/results/test_namespace/20_0multi_family_order.md index 5da10d9..0dfb231 100644 --- a/tests/docs/base/20_0multi_family_order.md +++ b/tests/results/test_namespace/20_0multi_family_order.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: # a variable -family: # a family - variable1: # a first variable - subfamily: # a sub family - variable: # a variable - variable2: # a second variable -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | diff --git a/tests/results/test_namespace/20_0multi_family_order.sh b/tests/results/test_namespace/20_0multi_family_order.sh new file mode 100644 index 0000000..95d19b6 --- /dev/null +++ b/tests/results/test_namespace/20_0multi_family_order.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.variable + string basic mandatory A variable. + + + + a family + +basic + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable1 + string basic mandatory A first variable. + + + a sub family + +basic + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.variable + string basic mandatory A variable. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable2 + string basic mandatory A second variable. + diff --git a/tests/docs/base/20_0validators_differ_redefine.adoc b/tests/results/test_namespace/20_0validators_differ_redefine.adoc similarity index 52% rename from tests/docs/base/20_0validators_differ_redefine.adoc rename to tests/results/test_namespace/20_0validators_differ_redefine.adoc index 16a7f7a..11faa5c 100644 --- a/tests/docs/base/20_0validators_differ_redefine.adoc +++ b/tests/results/test_namespace/20_0validators_differ_redefine.adoc @@ -1,38 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -var3: - redefine: true - validators: - - jinja: | - {% if _.var3 == _.var2 %} - var3 must be different than var2 - {% endif %} - description: var3 must be different than var2 ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: no # a first variable -var2: no # a second variable -var3: - description: a third variable - default: yes - test: - - yes - validators: - - jinja: | - {% if _.var3 == _.var1 %} - var3 must be different than var1 - {% endif %} - description: var3 must be different than var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/20_0validators_differ_redefine.json b/tests/results/test_namespace/20_0validators_differ_redefine.json similarity index 100% rename from tests/docs/base/20_0validators_differ_redefine.json rename to tests/results/test_namespace/20_0validators_differ_redefine.json diff --git a/tests/results/test_namespace/20_0validators_differ_redefine.md b/tests/results/test_namespace/20_0validators_differ_redefine.md new file mode 100644 index 0000000..eb427fd --- /dev/null +++ b/tests/results/test_namespace/20_0validators_differ_redefine.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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
**Example**: yes | + diff --git a/tests/results/test_namespace/20_0validators_differ_redefine.sh b/tests/results/test_namespace/20_0validators_differ_redefine.sh new file mode 100644 index 0000000..750903e --- /dev/null +++ b/tests/results/test_namespace/20_0validators_differ_redefine.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: no + rougail.var2 + string standard mandatory A second variable. + Default: no + rougail.var3 + string standard mandatory A third variable. + Validator: var3 must be different + than var2. + Default: yes + Example: yes + diff --git a/tests/results/test_namespace/20_1empty_subfamily.adoc b/tests/results/test_namespace/20_1empty_subfamily.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/20_1empty_subfamily.json b/tests/results/test_namespace/20_1empty_subfamily.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/20_1empty_subfamily.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/20_1empty_subfamily.md b/tests/results/test_namespace/20_1empty_subfamily.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/20_1empty_subfamily.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/20_1empty_subfamily.sh b/tests/results/test_namespace/20_1empty_subfamily.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/20_9default_information_parent.adoc b/tests/results/test_namespace/20_9default_information_parent.adoc similarity index 69% rename from tests/docs/base/20_9default_information_parent.adoc rename to tests/results/test_namespace/20_9default_information_parent.adoc index 62c1238..b966c04 100644 --- a/tests/docs/base/20_9default_information_parent.adoc +++ b/tests/results/test_namespace/20_9default_information_parent.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -family: - var1: # a first variable - var2: - description: a second variable - default: - type: information - information: test_information - variable: __.family ----- == Variables for "Rougail" === rougail.family diff --git a/tests/docs/base/20_9default_information_parent.json b/tests/results/test_namespace/20_9default_information_parent.json similarity index 100% rename from tests/docs/base/20_9default_information_parent.json rename to tests/results/test_namespace/20_9default_information_parent.json diff --git a/tests/results/test_namespace/20_9default_information_parent.md b/tests/results/test_namespace/20_9default_information_parent.md new file mode 100644 index 0000000..ef1c110 --- /dev/null +++ b/tests/results/test_namespace/20_9default_information_parent.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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**: the value of the information "test_information" of the variable "rougail.family". | + diff --git a/tests/results/test_namespace/20_9default_information_parent.sh b/tests/results/test_namespace/20_9default_information_parent.sh new file mode 100644 index 0000000..5387664 --- /dev/null +++ b/tests/results/test_namespace/20_9default_information_parent.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.family + +basic + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory A first variable. + rougail.family.var2 + string standard mandatory A second variable. + Default: the value of the information + "test_information" of the variable + "rougail.family". + diff --git a/tests/docs/base/24_0family_hidden_condition.adoc b/tests/results/test_namespace/24_0family_hidden_condition.adoc similarity index 64% rename from tests/docs/base/24_0family_hidden_condition.adoc rename to tests/results/test_namespace/24_0family_hidden_condition.adoc index a325850..41017c0 100644 --- a/tests/docs/base/24_0family_hidden_condition.adoc +++ b/tests/results/test_namespace/24_0family_hidden_condition.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - var1: # a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_condition.json b/tests/results/test_namespace/24_0family_hidden_condition.json similarity index 100% rename from tests/docs/base/24_0family_hidden_condition.json rename to tests/results/test_namespace/24_0family_hidden_condition.json diff --git a/tests/results/test_namespace/24_0family_hidden_condition.md b/tests/results/test_namespace/24_0family_hidden_condition.md new file mode 100644 index 0000000..0f0893d --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: if condition is yes. + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + diff --git a/tests/results/test_namespace/24_0family_hidden_condition.sh b/tests/results/test_namespace/24_0family_hidden_condition.sh new file mode 100644 index 0000000..dbc0cbd --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.adoc b/tests/results/test_namespace/24_0family_hidden_condition_boolean.adoc similarity index 62% rename from tests/docs/base/24_0family_hidden_condition_boolean.adoc rename to tests/results/test_namespace/24_0family_hidden_condition_boolean.adoc index 25fc085..c7459f0 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.adoc +++ b/tests/results/test_namespace/24_0family_hidden_condition_boolean.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: false # a conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition %} - condition is false - {% endif %} - description: if not condition - variable: - description: a variable - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.json b/tests/results/test_namespace/24_0family_hidden_condition_boolean.json similarity index 100% rename from tests/docs/base/24_0family_hidden_condition_boolean.json rename to tests/results/test_namespace/24_0family_hidden_condition_boolean.json diff --git a/tests/results/test_namespace/24_0family_hidden_condition_boolean.md b/tests/results/test_namespace/24_0family_hidden_condition_boolean.md new file mode 100644 index 0000000..2ca94f9 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_boolean.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: false | + +## a family + +`standard` *`hidden`* + +**Hidden**: if not condition. + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + diff --git a/tests/results/test_namespace/24_0family_hidden_condition_boolean.sh b/tests/results/test_namespace/24_0family_hidden_condition_boolean.sh new file mode 100644 index 0000000..9b7187b --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_boolean.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A conditional variable. + Default: false + + + + a family + +standard hidden + +Hidden: if not condition. + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.variable + string standard A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.adoc similarity index 65% rename from tests/docs/base/24_0family_hidden_condition_sub_family.adoc rename to tests/results/test_namespace/24_0family_hidden_condition_sub_family.adoc index 06d4ad0..b7f4883 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc +++ b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - subfamily: - var1: # a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.json b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.json similarity index 100% rename from tests/docs/base/24_0family_hidden_condition_sub_family.json rename to tests/results/test_namespace/24_0family_hidden_condition_sub_family.json diff --git a/tests/results/test_namespace/24_0family_hidden_condition_sub_family.md b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.md new file mode 100644 index 0000000..4bd3323 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: 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. | + diff --git a/tests/results/test_namespace/24_0family_hidden_condition_sub_family.sh b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.sh new file mode 100644 index 0000000..58205f9 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + rougail.family.subfamily + +basic + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.adoc similarity index 69% rename from tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc rename to tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.adoc index c1752b8..6773d1a 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc +++ b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: true # the variable use has condition -family: - description: possibly hidden family - hidden: - variable: _.condition - subfamily: # a subfamily - var1: - description: a variable - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.json b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.json similarity index 100% rename from tests/docs/base/24_0family_hidden_condition_variable_sub_family.json rename to tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.json diff --git a/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.md b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.md new file mode 100644 index 0000000..0e7876c --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## possibly hidden family + +`standard` *`hidden`* + +**Hidden**: when the variable "rougail.condition" has the value "true". + +### a subfamily + +`standard` + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + diff --git a/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.sh b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.sh new file mode 100644 index 0000000..3159af6 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_variable_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory The variable use has condition. + Default: true + + + + possibly hidden family + +standard hidden + +Hidden: when the variable "rougail.condition" has the value "true". + + a subfamily + +standard + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.subfamily.var1 + string standard A variable. + diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.adoc similarity index 60% rename from tests/docs/base/24_0family_hidden_condition_with_variable.adoc rename to tests/results/test_namespace/24_0family_hidden_condition_with_variable.adoc index 4a5729d..ba63bab 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc +++ b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.adoc @@ -1,29 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition1: false # a first conditional variable -condition2: false # a second conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition1 %} - condition1 is false - {% endif %} - description: if condition1 is false - variable: - description: a variable - hidden: - jinja: | - {% if rougail.condition2 %} - condition2 is true - {% endif %} - description: if condition2 is false - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.json b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.json similarity index 100% rename from tests/docs/base/24_0family_hidden_condition_with_variable.json rename to tests/results/test_namespace/24_0family_hidden_condition_with_variable.json diff --git a/tests/results/test_namespace/24_0family_hidden_condition_with_variable.md b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.md new file mode 100644 index 0000000..4c2e7aa --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a family + +`standard` *`hidden`* + +**Hidden**: if condition1 is false. + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A variable.
**Hidden**: if condition2 is false. | + diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.sh b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.sh similarity index 50% rename from tests/docs/base/24_0family_hidden_condition_with_variable.sh rename to tests/results/test_namespace/24_0family_hidden_condition_with_variable.sh index 0a9f7d7..2ad3913 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.sh +++ b/tests/results/test_namespace/24_0family_hidden_condition_with_variable.sh @@ -1,31 +1,6 @@ -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition1: false # a first conditional variable -condition2: false # a second conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition1 %} - condition1 is false - {% endif %} - description: if condition1 is false - variable: - description: a variable - hidden: - jinja: | - {% if rougail.condition2 %} - condition2 is true - {% endif %} - description: if condition2 is false - mandatory: false -``` -┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ Variables for "Rougail" ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ @@ -43,11 +18,11 @@ family: - a family + a family -standard hidden +standard hidden -Hidden: if condition1 is false. +Hidden: if condition1 is false. diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.adoc similarity index 60% rename from tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc rename to tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.adoc index ff7fe6a..8b5b0ca 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc +++ b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if condition == "yes" %} - condition is yes - {% endif %} - params: - condition: - variable: _.condition - description: if condition is yes - sub_family: # a subfamily - var1: # a variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.json b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.json similarity index 100% rename from tests/docs/base/24_0family_hidden_param_condition_sub_family.json rename to tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.json diff --git a/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.md b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.md new file mode 100644 index 0000000..c9f0038 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## possibly hidden family + +`basic` *`hidden`* + +**Hidden**: 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. | + diff --git a/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.sh b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.sh new file mode 100644 index 0000000..8b576c1 --- /dev/null +++ b/tests/results/test_namespace/24_0family_hidden_param_condition_sub_family.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory The variable use has condition. + Default: no + + + + possibly hidden family + +basic hidden + +Hidden: if condition is yes. + + a subfamily + +basic + + + +  Variable                              Description                          + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.sub_family.var1 + string basic mandatory A variable. + diff --git a/tests/docs/base/24_0family_mandatory_condition.adoc b/tests/results/test_namespace/24_0family_mandatory_condition.adoc similarity index 62% rename from tests/docs/base/24_0family_mandatory_condition.adoc rename to tests/results/test_namespace/24_0family_mandatory_condition.adoc index 08b9f38..ce3f37a 100644 --- a/tests/docs/base/24_0family_mandatory_condition.adoc +++ b/tests/results/test_namespace/24_0family_mandatory_condition.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -var: - description: a variable - mandatory: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: only if rougail.condition has the value "yes" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_mandatory_condition.json b/tests/results/test_namespace/24_0family_mandatory_condition.json similarity index 100% rename from tests/docs/base/24_0family_mandatory_condition.json rename to tests/results/test_namespace/24_0family_mandatory_condition.json diff --git a/tests/results/test_namespace/24_0family_mandatory_condition.md b/tests/results/test_namespace/24_0family_mandatory_condition.md new file mode 100644 index 0000000..f6b1e0a --- /dev/null +++ b/tests/results/test_namespace/24_0family_mandatory_condition.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/24_0family_mandatory_condition.sh b/tests/results/test_namespace/24_0family_mandatory_condition.sh new file mode 100644 index 0000000..f7652c7 --- /dev/null +++ b/tests/results/test_namespace/24_0family_mandatory_condition.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + rougail.var + string standard mandatory A variable. + Mandatory: only if rougail.condition + has the value "yes". + diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.adoc b/tests/results/test_namespace/24_0family_mandatory_condition_variable.adoc similarity index 75% rename from tests/docs/base/24_0family_mandatory_condition_variable.adoc rename to tests/results/test_namespace/24_0family_mandatory_condition_variable.adoc index 4ffc0bc..3610c57 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.adoc +++ b/tests/results/test_namespace/24_0family_mandatory_condition_variable.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: true # a condition -var: - description: a variable - mandatory: - variable: _.condition ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.json b/tests/results/test_namespace/24_0family_mandatory_condition_variable.json similarity index 100% rename from tests/docs/base/24_0family_mandatory_condition_variable.json rename to tests/results/test_namespace/24_0family_mandatory_condition_variable.json diff --git a/tests/results/test_namespace/24_0family_mandatory_condition_variable.md b/tests/results/test_namespace/24_0family_mandatory_condition_variable.md new file mode 100644 index 0000000..f3d276c --- /dev/null +++ b/tests/results/test_namespace/24_0family_mandatory_condition_variable.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/24_0family_mandatory_condition_variable.sh b/tests/results/test_namespace/24_0family_mandatory_condition_variable.sh new file mode 100644 index 0000000..c7cb751 --- /dev/null +++ b/tests/results/test_namespace/24_0family_mandatory_condition_variable.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + rougail.var + string standard mandatory A variable. + Mandatory: when the variable + "rougail.condition" has the value + "true". + diff --git a/tests/results/test_namespace/24_7validators_variable_optional.adoc b/tests/results/test_namespace/24_7validators_variable_optional.adoc new file mode 100644 index 0000000..aee5c7a --- /dev/null +++ b/tests/results/test_namespace/24_7validators_variable_optional.adoc @@ -0,0 +1,28 @@ +== Variables for "Rougail" + +=== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.general.int** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `basic` `mandatory` | +A first number. + +**Validators**: + +* int and int2 must be different. +* int and int3 must be different. + +**Example**: 5 +| + +**rougail.general.int2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `mandatory` | +A second number. + +**Default**: 1 +|==== + diff --git a/tests/docs/base/24_7validators_variable_optional.json b/tests/results/test_namespace/24_7validators_variable_optional.json similarity index 100% rename from tests/docs/base/24_7validators_variable_optional.json rename to tests/results/test_namespace/24_7validators_variable_optional.json diff --git a/tests/results/test_namespace/24_7validators_variable_optional.md b/tests/results/test_namespace/24_7validators_variable_optional.md new file mode 100644 index 0000000..4de5c2b --- /dev/null +++ b/tests/results/test_namespace/24_7validators_variable_optional.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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.
**Example**: 5 | +| **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | + diff --git a/tests/results/test_namespace/24_7validators_variable_optional.sh b/tests/results/test_namespace/24_7validators_variable_optional.sh new file mode 100644 index 0000000..96ed46f --- /dev/null +++ b/tests/results/test_namespace/24_7validators_variable_optional.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                             Description                         + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.int + number basic mandatory A first number. + Validators: + + + • int and int2 must be different. + • int and int3 must be different. Example: 5 + | | rougail.general.int2 number standard mandatory + | A second number. Default: 1 + | diff --git a/tests/results/test_namespace/24_family_disabled_var_hidden.adoc b/tests/results/test_namespace/24_family_disabled_var_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/24_family_disabled_var_hidden.json b/tests/results/test_namespace/24_family_disabled_var_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/24_family_disabled_var_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/24_family_disabled_var_hidden.md b/tests/results/test_namespace/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/24_family_disabled_var_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/24_family_disabled_var_hidden.sh b/tests/results/test_namespace/24_family_disabled_var_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/40_0leadership.adoc b/tests/results/test_namespace/40_0leadership.adoc similarity index 77% rename from tests/docs/base/40_0leadership.adoc rename to tests/results/test_namespace/40_0leadership.adoc index b46233f..235b246 100644 --- a/tests/docs/base/40_0leadership.adoc +++ b/tests/results/test_namespace/40_0leadership.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: # a follower - follower2: # an other follower ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership.json b/tests/results/test_namespace/40_0leadership.json similarity index 100% rename from tests/docs/base/40_0leadership.json rename to tests/results/test_namespace/40_0leadership.json diff --git a/tests/results/test_namespace/40_0leadership.md b/tests/results/test_namespace/40_0leadership.md new file mode 100644 index 0000000..50c02a1 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/40_0leadership.sh b/tests/results/test_namespace/40_0leadership.sh new file mode 100644 index 0000000..1b86e8e --- /dev/null +++ b/tests/results/test_namespace/40_0leadership.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique A leader. + multiple + rougail.leader.follower1 + string basic mandatory A follower. + rougail.leader.follower2 + string basic mandatory An other follower. + diff --git a/tests/docs/base/40_0leadership_diff_name.adoc b/tests/results/test_namespace/40_0leadership_diff_name.adoc similarity index 76% rename from tests/docs/base/40_0leadership_diff_name.adoc rename to tests/results/test_namespace/40_0leadership_diff_name.adoc index fac74e5..2d363f9 100644 --- a/tests/docs/base/40_0leadership_diff_name.adoc +++ b/tests/results/test_namespace/40_0leadership_diff_name.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leadership: - description: a leadership - type: leadership - leader: [] # a leader - follower1: # a follower - follower2: # an other follower ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership_diff_name.json b/tests/results/test_namespace/40_0leadership_diff_name.json similarity index 100% rename from tests/docs/base/40_0leadership_diff_name.json rename to tests/results/test_namespace/40_0leadership_diff_name.json diff --git a/tests/results/test_namespace/40_0leadership_diff_name.md b/tests/results/test_namespace/40_0leadership_diff_name.md new file mode 100644 index 0000000..8500b82 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_diff_name.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/40_0leadership_diff_name.sh b/tests/results/test_namespace/40_0leadership_diff_name.sh new file mode 100644 index 0000000..e041b76 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_diff_name.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leadership.leader + string basic mandatory unique A leader. + multiple + rougail.leadership.follower1 + string basic mandatory A follower. + rougail.leadership.follower2 + string basic mandatory An other follower. + diff --git a/tests/results/test_namespace/40_0leadership_empty.adoc b/tests/results/test_namespace/40_0leadership_empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/40_0leadership_empty.json b/tests/results/test_namespace/40_0leadership_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/40_0leadership_empty.md b/tests/results/test_namespace/40_0leadership_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/40_0leadership_empty.sh b/tests/results/test_namespace/40_0leadership_empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.adoc b/tests/results/test_namespace/40_0leadership_follower_default_calculation.adoc similarity index 70% rename from tests/docs/base/40_0leadership_follower_default_calculation.adoc rename to tests/results/test_namespace/40_0leadership_follower_default_calculation.adoc index b390c42..58361e0 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.adoc +++ b/tests/results/test_namespace/40_0leadership_follower_default_calculation.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: value # a follower - follower2: - description: a second follower - default: - jinja: | - {{ _.follower1 }} - description: returns follower1 value ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.json b/tests/results/test_namespace/40_0leadership_follower_default_calculation.json similarity index 100% rename from tests/docs/base/40_0leadership_follower_default_calculation.json rename to tests/results/test_namespace/40_0leadership_follower_default_calculation.json diff --git a/tests/results/test_namespace/40_0leadership_follower_default_calculation.md b/tests/results/test_namespace/40_0leadership_follower_default_calculation.md new file mode 100644 index 0000000..51fb2b7 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_calculation.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/40_0leadership_follower_default_calculation.sh b/tests/results/test_namespace/40_0leadership_follower_default_calculation.sh new file mode 100644 index 0000000..d9b3e3a --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_calculation.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique A leader. + multiple + rougail.leader.follower1 + string standard mandatory A follower. + Default: value + rougail.leader.follower2 + string standard mandatory A second follower. + Default: returns follower1 value. + diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.adoc b/tests/results/test_namespace/40_0leadership_follower_default_submulti.adoc similarity index 76% rename from tests/docs/base/40_0leadership_follower_default_submulti.adoc rename to tests/results/test_namespace/40_0leadership_follower_default_submulti.adoc index 42cfc8b..91d62cc 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.adoc +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - leader - follower1: # a follower1 - - value - follower2: # a follower2 - - value1 - - value2 ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.json b/tests/results/test_namespace/40_0leadership_follower_default_submulti.json similarity index 100% rename from tests/docs/base/40_0leadership_follower_default_submulti.json rename to tests/results/test_namespace/40_0leadership_follower_default_submulti.json diff --git a/tests/results/test_namespace/40_0leadership_follower_default_submulti.md b/tests/results/test_namespace/40_0leadership_follower_default_submulti.md new file mode 100644 index 0000000..5c56905 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`standard` + +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 | + diff --git a/tests/results/test_namespace/40_0leadership_follower_default_submulti.sh b/tests/results/test_namespace/40_0leadership_follower_default_submulti.sh new file mode 100644 index 0000000..25a1517 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti.sh @@ -0,0 +1,35 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique A leader. + multiple + Default: leader + rougail.leader.follower1 + string standard mandatory multiple A follower1. + Default: value + rougail.leader.follower2 + string standard mandatory multiple A follower2. + Default: + + + • value1 + • value2 + | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.adoc similarity index 73% rename from tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc rename to tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.adoc index 210c23a..1e23b21 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # the leader - - leader - follower1: # the follower1 - - value - follower2: - description: the follower2 - multi: true - default: - variable: _.follower1 ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.json b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.json similarity index 100% rename from tests/docs/base/40_0leadership_follower_default_submulti_calculation.json rename to tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.json diff --git a/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.md b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.md new file mode 100644 index 0000000..edc9604 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`standard` + +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". | + diff --git a/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.sh b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.sh new file mode 100644 index 0000000..4f0b64e --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_submulti_calculation.sh @@ -0,0 +1,32 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique The leader. + multiple + Default: leader + rougail.leader.follower1 + string standard mandatory multiple The follower1. + Default: value + rougail.leader.follower2 + string standard mandatory multiple The follower2. + Default: the value of the variable + "rougail.leader.follower1". + diff --git a/tests/docs/base/40_0leadership_follower_default_value.adoc b/tests/results/test_namespace/40_0leadership_follower_default_value.adoc similarity index 69% rename from tests/docs/base/40_0leadership_follower_default_value.adoc rename to tests/results/test_namespace/40_0leadership_follower_default_value.adoc index f5ced34..b0426ef 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.adoc +++ b/tests/results/test_namespace/40_0leadership_follower_default_value.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower1: value # a follower with default value ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_0leadership_follower_default_value.json b/tests/results/test_namespace/40_0leadership_follower_default_value.json similarity index 100% rename from tests/docs/base/40_0leadership_follower_default_value.json rename to tests/results/test_namespace/40_0leadership_follower_default_value.json diff --git a/tests/results/test_namespace/40_0leadership_follower_default_value.md b/tests/results/test_namespace/40_0leadership_follower_default_value.md new file mode 100644 index 0000000..c5b0e68 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_value.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`standard` + +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 | + diff --git a/tests/results/test_namespace/40_0leadership_follower_default_value.sh b/tests/results/test_namespace/40_0leadership_follower_default_value.sh new file mode 100644 index 0000000..0b08472 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_follower_default_value.sh @@ -0,0 +1,23 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower1 + string standard mandatory A follower with default value. + Default: value + diff --git a/tests/docs/base/40_0leadership_leader_not_multi.adoc b/tests/results/test_namespace/40_0leadership_leader_not_multi.adoc similarity index 72% rename from tests/docs/base/40_0leadership_leader_not_multi.adoc rename to tests/results/test_namespace/40_0leadership_leader_not_multi.adoc index 5dd8d72..a3dd444 100644 --- a/tests/docs/base/40_0leadership_leader_not_multi.adoc +++ b/tests/results/test_namespace/40_0leadership_leader_not_multi.adoc @@ -1,28 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -general: - mode_conteneur_actif: - type: string - description: No change - default: non -general1: - leader: - description: leader - type: leadership - leader: - type: string - description: leader - follower1: - type: string - description: follower1 - follower2: - type: string - description: follower2 -version: '1.0' ----- == Variables for "Rougail" === rougail.general diff --git a/tests/docs/base/40_0leadership_leader_not_multi.json b/tests/results/test_namespace/40_0leadership_leader_not_multi.json similarity index 100% rename from tests/docs/base/40_0leadership_leader_not_multi.json rename to tests/results/test_namespace/40_0leadership_leader_not_multi.json diff --git a/tests/results/test_namespace/40_0leadership_leader_not_multi.md b/tests/results/test_namespace/40_0leadership_leader_not_multi.md new file mode 100644 index 0000000..e5e36f1 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_leader_not_multi.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## rougail.general + +`standard` + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general.mode_conteneur_actif**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | No change.
**Default**: non | + +## rougail.general1 + +`basic` + +### rougail.general1.leader + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.general1.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Leader. | +| **rougail.general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | +| **rougail.general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | + diff --git a/tests/results/test_namespace/40_0leadership_leader_not_multi.sh b/tests/results/test_namespace/40_0leadership_leader_not_multi.sh new file mode 100644 index 0000000..3518608 --- /dev/null +++ b/tests/results/test_namespace/40_0leadership_leader_not_multi.sh @@ -0,0 +1,44 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.general + +standard + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.mode_conteneur_actif + string standard mandatory No change. + Default: non + + + + rougail.general1 + +basic + + rougail.general1.leader + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general1.leader.leader + string basic mandatory unique Leader. + multiple + rougail.general1.leader.follower1 + string basic mandatory Follower1. + rougail.general1.leader.follower2 + string basic mandatory Follower2. + diff --git a/tests/docs/base/40_1leadership_append_follower.adoc b/tests/results/test_namespace/40_1leadership_append_follower.adoc similarity index 69% rename from tests/docs/base/40_1leadership_append_follower.adoc rename to tests/results/test_namespace/40_1leadership_append_follower.adoc index 954431b..1e40582 100644 --- a/tests/docs/base/40_1leadership_append_follower.adoc +++ b/tests/results/test_namespace/40_1leadership_append_follower.adoc @@ -1,30 +1,3 @@ -== dictionaries/rougail/01-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - follower3: - description: the follower3 ----- -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: the leader - multi: true - follower1: - description: the follower1 - follower2: - description: the follower2 ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_1leadership_append_follower.json b/tests/results/test_namespace/40_1leadership_append_follower.json similarity index 100% rename from tests/docs/base/40_1leadership_append_follower.json rename to tests/results/test_namespace/40_1leadership_append_follower.json diff --git a/tests/results/test_namespace/40_1leadership_append_follower.md b/tests/results/test_namespace/40_1leadership_append_follower.md new file mode 100644 index 0000000..d399e83 --- /dev/null +++ b/tests/results/test_namespace/40_1leadership_append_follower.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/40_1leadership_append_follower.sh b/tests/results/test_namespace/40_1leadership_append_follower.sh new file mode 100644 index 0000000..af31d7a --- /dev/null +++ b/tests/results/test_namespace/40_1leadership_append_follower.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique The leader. + multiple + rougail.leader.follower1 + string basic mandatory The follower1. + rougail.leader.follower2 + string basic mandatory The follower2. + rougail.leader.follower3 + string basic mandatory The follower3. + diff --git a/tests/docs/base/40_2leadership_calculation_index.adoc b/tests/results/test_namespace/40_2leadership_calculation_index.adoc similarity index 69% rename from tests/docs/base/40_2leadership_calculation_index.adoc rename to tests/results/test_namespace/40_2leadership_calculation_index.adoc index 901f86b..64107f7 100644 --- a/tests/docs/base/40_2leadership_calculation_index.adoc +++ b/tests/results/test_namespace/40_2leadership_calculation_index.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - type: index ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_2leadership_calculation_index.json b/tests/results/test_namespace/40_2leadership_calculation_index.json similarity index 100% rename from tests/docs/base/40_2leadership_calculation_index.json rename to tests/results/test_namespace/40_2leadership_calculation_index.json diff --git a/tests/results/test_namespace/40_2leadership_calculation_index.md b/tests/results/test_namespace/40_2leadership_calculation_index.md new file mode 100644 index 0000000..36c66df --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_calculation_index.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`standard` + +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**: the value of the index. | + diff --git a/tests/results/test_namespace/40_2leadership_calculation_index.sh b/tests/results/test_namespace/40_2leadership_calculation_index.sh new file mode 100644 index 0000000..f727d22 --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_calculation_index.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • a + • b + • c + | | rougail.leader.follower1 number standard mandatory + | A follower. Default: the value of the index. + | diff --git a/tests/docs/base/40_2leadership_calculation_param_index.adoc b/tests/results/test_namespace/40_2leadership_calculation_param_index.adoc similarity index 62% rename from tests/docs/base/40_2leadership_calculation_param_index.adoc rename to tests/results/test_namespace/40_2leadership_calculation_param_index.adoc index d328db0..e93d347 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.adoc +++ b/tests/results/test_namespace/40_2leadership_calculation_param_index.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - jinja: '{{ index }}' - params: - index: - type: index - description: returns index ----- == Variables for "Rougail" === leadership diff --git a/tests/docs/base/40_2leadership_calculation_param_index.json b/tests/results/test_namespace/40_2leadership_calculation_param_index.json similarity index 100% rename from tests/docs/base/40_2leadership_calculation_param_index.json rename to tests/results/test_namespace/40_2leadership_calculation_param_index.json diff --git a/tests/results/test_namespace/40_2leadership_calculation_param_index.md b/tests/results/test_namespace/40_2leadership_calculation_param_index.md new file mode 100644 index 0000000..f92b2d9 --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_calculation_param_index.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## leadership + +`standard` + +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. | + diff --git a/tests/results/test_namespace/40_2leadership_calculation_param_index.sh b/tests/results/test_namespace/40_2leadership_calculation_param_index.sh new file mode 100644 index 0000000..04da134 --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_calculation_param_index.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • a + • b + • c + | | rougail.leader.follower1 number standard mandatory + | A follower. Default: returns index. + | diff --git a/tests/docs/base/40_2leadership_leader_calculation.adoc b/tests/results/test_namespace/40_2leadership_leader_calculation.adoc similarity index 68% rename from tests/docs/base/40_2leadership_leader_calculation.adoc rename to tests/results/test_namespace/40_2leadership_leader_calculation.adoc index 2b6bbd9..e5a2af7 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.adoc +++ b/tests/results/test_namespace/40_2leadership_leader_calculation.adoc @@ -1,27 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - default: - jinja: | - val1 - val2 - description: returns val1 and val2 - - follower1: # a first follower - - follower2: # a second follower ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/40_2leadership_leader_calculation.json b/tests/results/test_namespace/40_2leadership_leader_calculation.json similarity index 100% rename from tests/docs/base/40_2leadership_leader_calculation.json rename to tests/results/test_namespace/40_2leadership_leader_calculation.json diff --git a/tests/results/test_namespace/40_2leadership_leader_calculation.md b/tests/results/test_namespace/40_2leadership_leader_calculation.md new file mode 100644 index 0000000..e82a113 --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_leader_calculation.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/40_2leadership_leader_calculation.sh b/tests/results/test_namespace/40_2leadership_leader_calculation.sh new file mode 100644 index 0000000..ce11cc5 --- /dev/null +++ b/tests/results/test_namespace/40_2leadership_leader_calculation.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique A leader. + multiple + Default: returns val1 and val2. + rougail.leader.follower1 + string basic mandatory A first follower. + rougail.leader.follower2 + string basic mandatory A second follower. + diff --git a/tests/docs/base/40_6leadership_follower_multi.adoc b/tests/results/test_namespace/40_6leadership_follower_multi.adoc similarity index 69% rename from tests/docs/base/40_6leadership_follower_multi.adoc rename to tests/results/test_namespace/40_6leadership_follower_multi.adoc index 7bcd8ed..d3f47ab 100644 --- a/tests/docs/base/40_6leadership_follower_multi.adoc +++ b/tests/results/test_namespace/40_6leadership_follower_multi.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -leadership: - description: A leadership - type: leadership - leader: - description: The leader - multi: true - follower1: - description: The first follower - multi: true - follower2: - description: The second follower - multi: true - default: - - value ----- == Variables for "Rougail" === A leadership diff --git a/tests/docs/base/40_6leadership_follower_multi.json b/tests/results/test_namespace/40_6leadership_follower_multi.json similarity index 100% rename from tests/docs/base/40_6leadership_follower_multi.json rename to tests/results/test_namespace/40_6leadership_follower_multi.json diff --git a/tests/results/test_namespace/40_6leadership_follower_multi.md b/tests/results/test_namespace/40_6leadership_follower_multi.md new file mode 100644 index 0000000..0cbf813 --- /dev/null +++ b/tests/results/test_namespace/40_6leadership_follower_multi.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## A leadership + +`basic` + +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 | + diff --git a/tests/results/test_namespace/40_6leadership_follower_multi.sh b/tests/results/test_namespace/40_6leadership_follower_multi.sh new file mode 100644 index 0000000..83a7cc1 --- /dev/null +++ b/tests/results/test_namespace/40_6leadership_follower_multi.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leadership.leader + string basic mandatory unique The leader. + multiple + rougail.leadership.follower1 + string basic mandatory multiple The first follower. + rougail.leadership.follower2 + string standard mandatory multiple The second follower. + Default: value + diff --git a/tests/docs/base/40_8calculation_boolean.adoc b/tests/results/test_namespace/40_8calculation_boolean.adoc similarity index 57% rename from tests/docs/base/40_8calculation_boolean.adoc rename to tests/results/test_namespace/40_8calculation_boolean.adoc index da89b77..4ac4798 100644 --- a/tests/docs/base/40_8calculation_boolean.adoc +++ b/tests/results/test_namespace/40_8calculation_boolean.adoc @@ -1,37 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -bool: false # a boolean variable -multi1: - description: a first multi variable - type: boolean - multi: true - default: - jinja: | - {% if _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation -multi2: - description: a second multi variable - type: boolean - multi: true - default: - jinja: | - {% if not _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/40_8calculation_boolean.json b/tests/results/test_namespace/40_8calculation_boolean.json similarity index 100% rename from tests/docs/base/40_8calculation_boolean.json rename to tests/results/test_namespace/40_8calculation_boolean.json diff --git a/tests/results/test_namespace/40_8calculation_boolean.md b/tests/results/test_namespace/40_8calculation_boolean.md new file mode 100644 index 0000000..f6b59e5 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_boolean.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/40_8calculation_boolean.sh b/tests/results/test_namespace/40_8calculation_boolean.sh new file mode 100644 index 0000000..f5fcd20 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_boolean.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.bool + boolean standard mandatory A boolean variable. + Default: false + rougail.multi1 + boolean standard mandatory unique A first multi variable. + multiple + Default: a calculation. + rougail.multi2 + boolean standard mandatory unique A second multi variable. + multiple + Default: a calculation. + diff --git a/tests/docs/base/40_8calculation_boolean_return_none.adoc b/tests/results/test_namespace/40_8calculation_boolean_return_none.adoc similarity index 62% rename from tests/docs/base/40_8calculation_boolean_return_none.adoc rename to tests/results/test_namespace/40_8calculation_boolean_return_none.adoc index 7d09521..8e03a67 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.adoc +++ b/tests/results/test_namespace/40_8calculation_boolean_return_none.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: yes # a first variable -var2: - description: a second variable - type: boolean - default: - jinja: | - {% if rougail.var1 == 'no' %} - false - {% endif %} - description: return false if the value of var1 is "no" ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/40_8calculation_boolean_return_none.json b/tests/results/test_namespace/40_8calculation_boolean_return_none.json similarity index 100% rename from tests/docs/base/40_8calculation_boolean_return_none.json rename to tests/results/test_namespace/40_8calculation_boolean_return_none.json diff --git a/tests/results/test_namespace/40_8calculation_boolean_return_none.md b/tests/results/test_namespace/40_8calculation_boolean_return_none.md new file mode 100644 index 0000000..8e7c882 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_boolean_return_none.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + diff --git a/tests/results/test_namespace/40_8calculation_boolean_return_none.sh b/tests/results/test_namespace/40_8calculation_boolean_return_none.sh new file mode 100644 index 0000000..c38994a --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_boolean_return_none.sh @@ -0,0 +1,19 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory A first variable. + Default: yes + rougail.var2 + boolean standard mandatory A second variable. + Default: return false if the value + of var1 is "no". + diff --git a/tests/docs/base/40_8calculation_integer.adoc b/tests/results/test_namespace/40_8calculation_integer.adoc similarity index 60% rename from tests/docs/base/40_8calculation_integer.adoc rename to tests/results/test_namespace/40_8calculation_integer.adoc index 6c56756..4e39fc4 100644 --- a/tests/docs/base/40_8calculation_integer.adoc +++ b/tests/results/test_namespace/40_8calculation_integer.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -bool: false # a boolean variable -int1: - description: first integer variable - type: number - default: - jinja: | - {% if rougail.bool %}1{% else %}2{% endif %} - description: if bool returns 1 otherwise return 2 -int2: - description: second integer variable - type: number - default: - jinja: | - {% if not rougail.bool %}3{% else %}4{% endif %} - description: if bool returns 3 otherwise return 4 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/40_8calculation_integer.json b/tests/results/test_namespace/40_8calculation_integer.json similarity index 100% rename from tests/docs/base/40_8calculation_integer.json rename to tests/results/test_namespace/40_8calculation_integer.json diff --git a/tests/results/test_namespace/40_8calculation_integer.md b/tests/results/test_namespace/40_8calculation_integer.md new file mode 100644 index 0000000..3baead1 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_integer.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + diff --git a/tests/results/test_namespace/40_8calculation_integer.sh b/tests/results/test_namespace/40_8calculation_integer.sh new file mode 100644 index 0000000..4128d6e --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_integer.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.bool + boolean standard mandatory A boolean variable. + Default: false + rougail.int1 + number standard mandatory First integer variable. + Default: if bool returns 1 otherwise + return 2. + rougail.int2 + number standard mandatory Second integer variable. + Default: if bool returns 3 otherwise + return 4. + diff --git a/tests/docs/base/40_8calculation_multi_variable.adoc b/tests/results/test_namespace/40_8calculation_multi_variable.adoc similarity index 76% rename from tests/docs/base/40_8calculation_multi_variable.adoc rename to tests/results/test_namespace/40_8calculation_multi_variable.adoc index 2765828..f94307e 100644 --- a/tests/docs/base/40_8calculation_multi_variable.adoc +++ b/tests/results/test_namespace/40_8calculation_multi_variable.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: - description: a first variable - default: - - variable: _.var2 - - variable: _.var3 -var2: no # a second variable -var3: yes # a third variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/40_8calculation_multi_variable.json b/tests/results/test_namespace/40_8calculation_multi_variable.json similarity index 100% rename from tests/docs/base/40_8calculation_multi_variable.json rename to tests/results/test_namespace/40_8calculation_multi_variable.json diff --git a/tests/results/test_namespace/40_8calculation_multi_variable.md b/tests/results/test_namespace/40_8calculation_multi_variable.md new file mode 100644 index 0000000..e6759c5 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable.md @@ -0,0 +1,12 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/40_8calculation_multi_variable.sh b/tests/results/test_namespace/40_8calculation_multi_variable.sh new file mode 100644 index 0000000..d6c1f74 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A first variable. + multiple + Default: + + + • the value of the variable "rougail.var2". + • the value of the variable "rougail.var3". + | | rougail.var2 string standard mandatory + | A second variable. Default: no + | | rougail.var3 string standard mandatory + | A third variable. Default: yes + | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.adoc b/tests/results/test_namespace/40_8calculation_multi_variable_parent.adoc similarity index 75% rename from tests/docs/base/40_8calculation_multi_variable_parent.adoc rename to tests/results/test_namespace/40_8calculation_multi_variable_parent.adoc index 1f56749..8aad5b4 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.adoc +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: no # a variable -fam1: # a family - var: - description: a calculated variable - default: - variable: __.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.json b/tests/results/test_namespace/40_8calculation_multi_variable_parent.json similarity index 100% rename from tests/docs/base/40_8calculation_multi_variable_parent.json rename to tests/results/test_namespace/40_8calculation_multi_variable_parent.json diff --git a/tests/results/test_namespace/40_8calculation_multi_variable_parent.md b/tests/results/test_namespace/40_8calculation_multi_variable_parent.md new file mode 100644 index 0000000..cf303ee --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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". | + diff --git a/tests/results/test_namespace/40_8calculation_multi_variable_parent.sh b/tests/results/test_namespace/40_8calculation_multi_variable_parent.sh new file mode 100644 index 0000000..c1359fa --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent.sh @@ -0,0 +1,29 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A variable. + Default: no + + + + a family + +standard + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam1.var + string standard mandatory A calculated variable. + Default: the value of the variable + "rougail.var". + diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.adoc similarity index 73% rename from tests/docs/base/40_8calculation_multi_variable_parent2.adoc rename to tests/results/test_namespace/40_8calculation_multi_variable_parent2.adoc index a7e9313..03e2f98 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -fam1: # first family - var: no # a variable -fam2: # second family - var: - description: a varaible - default: - variable: __.fam1.var ----- == Variables for "Rougail" === first family diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.json b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.json similarity index 100% rename from tests/docs/base/40_8calculation_multi_variable_parent2.json rename to tests/results/test_namespace/40_8calculation_multi_variable_parent2.json diff --git a/tests/results/test_namespace/40_8calculation_multi_variable_parent2.md b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.md new file mode 100644 index 0000000..98f1d39 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## 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". | + diff --git a/tests/results/test_namespace/40_8calculation_multi_variable_parent2.sh b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.sh new file mode 100644 index 0000000..242d352 --- /dev/null +++ b/tests/results/test_namespace/40_8calculation_multi_variable_parent2.sh @@ -0,0 +1,34 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + first family + +standard + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam1.var + string standard mandatory A variable. + Default: no + + + + second family + +standard + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.fam2.var + string standard mandatory A varaible. + Default: the value of the variable + "rougail.fam1.var". + diff --git a/tests/docs/base/41_0choice_leader.adoc b/tests/results/test_namespace/41_0choice_leader.adoc similarity index 64% rename from tests/docs/base/41_0choice_leader.adoc rename to tests/results/test_namespace/41_0choice_leader.adoc index 40c5b8e..dfc640e 100644 --- a/tests/docs/base/41_0choice_leader.adoc +++ b/tests/results/test_namespace/41_0choice_leader.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -leader: - description: The leadership - type: leadership - leader: - description: The leader - multi: true - mandatory: false - follower1: - type: choice - description: A follower - choices: - - a - - b - - c ----- == Variables for "Rougail" === The leadership diff --git a/tests/docs/base/41_0choice_leader.json b/tests/results/test_namespace/41_0choice_leader.json similarity index 100% rename from tests/docs/base/41_0choice_leader.json rename to tests/results/test_namespace/41_0choice_leader.json diff --git a/tests/results/test_namespace/41_0choice_leader.md b/tests/results/test_namespace/41_0choice_leader.md new file mode 100644 index 0000000..692e410 --- /dev/null +++ b/tests/results/test_namespace/41_0choice_leader.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## The leadership + +`basic` + +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 | + diff --git a/tests/results/test_namespace/41_0choice_leader.sh b/tests/results/test_namespace/41_0choice_leader.sh new file mode 100644 index 0000000..4f5523c --- /dev/null +++ b/tests/results/test_namespace/41_0choice_leader.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + The leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple The leader. + rougail.leader.follower1 + choice basic mandatory A follower. + Choices: + + + • a + • b + • c + | diff --git a/tests/results/test_namespace/44_0leadership_hidden.adoc b/tests/results/test_namespace/44_0leadership_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/44_0leadership_hidden.json b/tests/results/test_namespace/44_0leadership_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/44_0leadership_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/44_0leadership_hidden.md b/tests/results/test_namespace/44_0leadership_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/44_0leadership_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/44_0leadership_hidden.sh b/tests/results/test_namespace/44_0leadership_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/44_0leadership_leader_hidden.adoc b/tests/results/test_namespace/44_0leadership_leader_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/44_0leadership_leader_hidden.json b/tests/results/test_namespace/44_0leadership_leader_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/44_0leadership_leader_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/44_0leadership_leader_hidden.md b/tests/results/test_namespace/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/44_0leadership_leader_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/44_0leadership_leader_hidden.sh b/tests/results/test_namespace/44_0leadership_leader_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/44_1leadership_append_hidden_follower.adoc b/tests/results/test_namespace/44_1leadership_append_hidden_follower.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/44_1leadership_append_hidden_follower.json b/tests/results/test_namespace/44_1leadership_append_hidden_follower.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/44_1leadership_append_hidden_follower.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/44_1leadership_append_hidden_follower.md b/tests/results/test_namespace/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/44_1leadership_append_hidden_follower.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/44_1leadership_append_hidden_follower.sh b/tests/results/test_namespace/44_1leadership_append_hidden_follower.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/44_4disabled_calcultion_follower.adoc b/tests/results/test_namespace/44_4disabled_calcultion_follower.adoc similarity index 67% rename from tests/docs/base/44_4disabled_calcultion_follower.adoc rename to tests/results/test_namespace/44_4disabled_calcultion_follower.adoc index 39954dc..adf6f51 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.adoc +++ b/tests/results/test_namespace/44_4disabled_calcultion_follower.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: true # a condition -leader: - description: a leadership - type: leadership - leader: - description: aleader - default: - - a - follower: - description: a follower - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/44_4disabled_calcultion_follower.json b/tests/results/test_namespace/44_4disabled_calcultion_follower.json similarity index 100% rename from tests/docs/base/44_4disabled_calcultion_follower.json rename to tests/results/test_namespace/44_4disabled_calcultion_follower.json diff --git a/tests/results/test_namespace/44_4disabled_calcultion_follower.md b/tests/results/test_namespace/44_4disabled_calcultion_follower.md new file mode 100644 index 0000000..acb28fa --- /dev/null +++ b/tests/results/test_namespace/44_4disabled_calcultion_follower.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                    | Description                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: true | + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/44_4disabled_calcultion_follower.sh b/tests/results/test_namespace/44_4disabled_calcultion_follower.sh new file mode 100644 index 0000000..fb55153 --- /dev/null +++ b/tests/results/test_namespace/44_4disabled_calcultion_follower.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: true + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique Aleader. + multiple + Default: a + rougail.leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/docs/base/44_4leadership_mandatory.adoc b/tests/results/test_namespace/44_4leadership_mandatory.adoc similarity index 66% rename from tests/docs/base/44_4leadership_mandatory.adoc rename to tests/results/test_namespace/44_4leadership_mandatory.adoc index bd6dfbf..d3c0df2 100644 --- a/tests/docs/base/44_4leadership_mandatory.adoc +++ b/tests/results/test_namespace/44_4leadership_mandatory.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: true - follower1: - description: a follower - mandatory: false ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/44_4leadership_mandatory.json b/tests/results/test_namespace/44_4leadership_mandatory.json similarity index 100% rename from tests/docs/base/44_4leadership_mandatory.json rename to tests/results/test_namespace/44_4leadership_mandatory.json diff --git a/tests/results/test_namespace/44_4leadership_mandatory.md b/tests/results/test_namespace/44_4leadership_mandatory.md new file mode 100644 index 0000000..ac8803e --- /dev/null +++ b/tests/results/test_namespace/44_4leadership_mandatory.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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` | A follower. | + diff --git a/tests/results/test_namespace/44_4leadership_mandatory.sh b/tests/results/test_namespace/44_4leadership_mandatory.sh new file mode 100644 index 0000000..3cccf10 --- /dev/null +++ b/tests/results/test_namespace/44_4leadership_mandatory.sh @@ -0,0 +1,22 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique A leader. + multiple + rougail.leader.follower1 + string standard A follower. + diff --git a/tests/docs/base/44_4leadership_mandatory_follower.adoc b/tests/results/test_namespace/44_4leadership_mandatory_follower.adoc similarity index 66% rename from tests/docs/base/44_4leadership_mandatory_follower.adoc rename to tests/results/test_namespace/44_4leadership_mandatory_follower.adoc index 8e59206..ef644b8 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.adoc +++ b/tests/results/test_namespace/44_4leadership_mandatory_follower.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: true ----- == Variables for "Rougail" === a leadership diff --git a/tests/docs/base/44_4leadership_mandatory_follower.json b/tests/results/test_namespace/44_4leadership_mandatory_follower.json similarity index 100% rename from tests/docs/base/44_4leadership_mandatory_follower.json rename to tests/results/test_namespace/44_4leadership_mandatory_follower.json diff --git a/tests/results/test_namespace/44_4leadership_mandatory_follower.md b/tests/results/test_namespace/44_4leadership_mandatory_follower.md new file mode 100644 index 0000000..08212da --- /dev/null +++ b/tests/results/test_namespace/44_4leadership_mandatory_follower.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/44_4leadership_mandatory_follower.sh b/tests/results/test_namespace/44_4leadership_mandatory_follower.sh new file mode 100644 index 0000000..66a70e9 --- /dev/null +++ b/tests/results/test_namespace/44_4leadership_mandatory_follower.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.adoc similarity index 66% rename from tests/docs/base/44_5leadership_leader_hidden_calculation.adoc rename to tests/results/test_namespace/44_5leadership_leader_hidden_calculation.adoc index 2e34cda..fbcb171 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: no # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: - jinja: | - {% if __.condition == "no" %} - condition is no - {% endif %} - description: if condition is no - mandatory: false - follower: # a follower ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.json b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.json similarity index 100% rename from tests/docs/base/44_5leadership_leader_hidden_calculation.json rename to tests/results/test_namespace/44_5leadership_leader_hidden_calculation.json diff --git a/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.md b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.md new file mode 100644 index 0000000..fc92888 --- /dev/null +++ b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | + +## a leadership + +`basic` *`hidden`* + +**Hidden**: if condition is no. + +This family contains lists of variable blocks. + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.leader.leader**
[`string`](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. | + diff --git a/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.sh b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.sh new file mode 100644 index 0000000..a0fefa6 --- /dev/null +++ b/tests/results/test_namespace/44_5leadership_leader_hidden_calculation.sh @@ -0,0 +1,33 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: no + + + + a leadership + +basic hidden + +Hidden: if condition is no. + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard unique multiple A leader. + rougail.leader.follower + string basic mandatory A follower. + diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.adoc similarity index 67% rename from tests/docs/base/44_6leadership_follower_disabled_calculation.adoc rename to tests/results/test_namespace/44_6leadership_follower_disabled_calculation.adoc index 2e3460b..9ed1106 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -condition: yes # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower: - description: a follower - disabled: - jinja: | - {% if __.condition == "yes" %} - disabled - {% endif %} - description: if condition is yes ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.json b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.json similarity index 100% rename from tests/docs/base/44_6leadership_follower_disabled_calculation.json rename to tests/results/test_namespace/44_6leadership_follower_disabled_calculation.json diff --git a/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.md b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.md new file mode 100644 index 0000000..ce64d5a --- /dev/null +++ b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | + +## a leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.sh b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.sh new file mode 100644 index 0000000..a0fbce7 --- /dev/null +++ b/tests/results/test_namespace/44_6leadership_follower_disabled_calculation.sh @@ -0,0 +1,34 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A condition. + Default: yes + + + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic mandatory unique A leader. + multiple + rougail.leader.follower + string basic mandatory disabled A follower. + Disabled: if condition is yes. + diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.adoc b/tests/results/test_namespace/44_9calculated_default_leadership_leader.adoc similarity index 63% rename from tests/docs/base/44_9calculated_default_leadership_leader.adoc rename to tests/results/test_namespace/44_9calculated_default_leadership_leader.adoc index 141fdec..9a410cf 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.adoc +++ b/tests/results/test_namespace/44_9calculated_default_leadership_leader.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -leader: - description: leader - type: leadership - leader: # a leader - - a - - b - follower: - description: a follower - disabled: - jinja: | - {% if _.leader == "a" %} - the value of "leader" is "a" - {% endif %} - description: if the value of "leader" is "a" - default: - variable: _.leader ----- == Variables for "Rougail" === rougail.leader diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.json b/tests/results/test_namespace/44_9calculated_default_leadership_leader.json similarity index 100% rename from tests/docs/base/44_9calculated_default_leadership_leader.json rename to tests/results/test_namespace/44_9calculated_default_leadership_leader.json diff --git a/tests/results/test_namespace/44_9calculated_default_leadership_leader.md b/tests/results/test_namespace/44_9calculated_default_leadership_leader.md new file mode 100644 index 0000000..d791171 --- /dev/null +++ b/tests/results/test_namespace/44_9calculated_default_leadership_leader.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## rougail.leader + +`standard` + +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". | + diff --git a/tests/results/test_namespace/44_9calculated_default_leadership_leader.sh b/tests/results/test_namespace/44_9calculated_default_leadership_leader.sh new file mode 100644 index 0000000..8de87be --- /dev/null +++ b/tests/results/test_namespace/44_9calculated_default_leadership_leader.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.leader + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • a + • b + | | rougail.leader.follower string standard mandatory disabled + | A follower. Default: the value of the variable "rougail.leader.leader". + Disabled: if the value of "leader" is "a". + | diff --git a/tests/docs/base/60_0family_dynamic.adoc b/tests/results/test_namespace/60_0family_dynamic.adoc similarity index 75% rename from tests/docs/base/60_0family_dynamic.adoc rename to tests/results/test_namespace/60_0family_dynamic.adoc index 22b6f9d..14a9ae4 100644 --- a/tests/docs/base/60_0family_dynamic.adoc +++ b/tests/results/test_namespace/60_0family_dynamic.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: # A dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic.json b/tests/results/test_namespace/60_0family_dynamic.json similarity index 100% rename from tests/docs/base/60_0family_dynamic.json rename to tests/results/test_namespace/60_0family_dynamic.json diff --git a/tests/docs/base/60_0family_dynamic.md b/tests/results/test_namespace/60_0family_dynamic.md similarity index 97% rename from tests/docs/base/60_0family_dynamic.md rename to tests/results/test_namespace/60_0family_dynamic.md index f0649c0..fa41d8e 100644 --- a/tests/docs/base/60_0family_dynamic.md +++ b/tests/results/test_namespace/60_0family_dynamic.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: # A dynamic variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/60_0family_dynamic.sh b/tests/results/test_namespace/60_0family_dynamic.sh new file mode 100644 index 0000000..00b32a6 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_0.adoc b/tests/results/test_namespace/60_0family_dynamic_1_0.adoc similarity index 73% rename from tests/docs/base/60_0family_dynamic_1_0.adoc rename to tests/results/test_namespace/60_0family_dynamic_1_0.adoc index 90002ba..0ab7318 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_1_0.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - type: dynamic - variable: rougail.var - vardyn: - description: Dynamic variable - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_1_0.json b/tests/results/test_namespace/60_0family_dynamic_1_0.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_1_0.json rename to tests/results/test_namespace/60_0family_dynamic_1_0.json diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0.md b/tests/results/test_namespace/60_0family_dynamic_1_0.md new file mode 100644 index 0000000..969b093 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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.dyn*val1* or rougail.dyn*val2* + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0.sh b/tests/results/test_namespace/60_0family_dynamic_1_0.sh new file mode 100644 index 0000000..c14446c --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard Dynamic variable. + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.adoc new file mode 100644 index 0000000..3e19e23 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.adoc @@ -0,0 +1,35 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== rougail.dyn__val1__ or rougail.dyn__val2__ + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +Dynamic variable. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_empty.json b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.json new file mode 100644 index 0000000..79a46a1 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["Dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_empty.md b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.md new file mode 100644 index 0000000..2df45f2 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | Dynamic variable. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_empty.sh b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.sh new file mode 100644 index 0000000..68a5118 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard Dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.adoc b/tests/results/test_namespace/60_0family_dynamic_1_0_type.adoc similarity index 75% rename from tests/docs/base/60_0family_dynamic_1_0_type.adoc rename to tests/results/test_namespace/60_0family_dynamic_1_0_type.adoc index 608f80c..ad6c5b1 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - _type: dynamic - variable: rougail.var - vardyn: - description: A dyn variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.json b/tests/results/test_namespace/60_0family_dynamic_1_0_type.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_1_0_type.json rename to tests/results/test_namespace/60_0family_dynamic_1_0_type.json diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.md b/tests/results/test_namespace/60_0family_dynamic_1_0_type.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_1_0_type.md rename to tests/results/test_namespace/60_0family_dynamic_1_0_type.md index f3de733..3a5e51c 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.md +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - _type: dynamic - variable: rougail.var - vardyn: - description: A dyn variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_type.sh b/tests/results/test_namespace/60_0family_dynamic_1_0_type.sh new file mode 100644 index 0000000..3f87517 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dyn variable. + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.adoc new file mode 100644 index 0000000..a90566a --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.adoc @@ -0,0 +1,35 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== rougail.dyn__val1__ or rougail.dyn__val2__ + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dyn variable. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.json b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.json new file mode 100644 index 0000000..9b0c9d7 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dyn variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.md b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.md new file mode 100644 index 0000000..2e586af --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dyn variable. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.sh b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.sh new file mode 100644 index 0000000..17126d3 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_0_type_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dyn variable. + diff --git a/tests/docs/base/60_0family_dynamic_1_1.adoc b/tests/results/test_namespace/60_0family_dynamic_1_1.adoc similarity index 75% rename from tests/docs/base/60_0family_dynamic_1_1.adoc rename to tests/results/test_namespace/60_0family_dynamic_1_1.adoc index 2952633..f6dc321 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_1_1.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn: - type: dynamic - description: A dynamic family - variable: _.var - vardyn: - description: A dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_1_1.json b/tests/results/test_namespace/60_0family_dynamic_1_1.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_1_1.json rename to tests/results/test_namespace/60_0family_dynamic_1_1.json diff --git a/tests/docs/base/60_0family_dynamic_1_1.md b/tests/results/test_namespace/60_0family_dynamic_1_1.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_1_1.md rename to tests/results/test_namespace/60_0family_dynamic_1_1.md index d8dbeba..8b8de6e 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.md +++ b/tests/results/test_namespace/60_0family_dynamic_1_1.md @@ -2,21 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn: - type: dynamic - description: A dynamic family - variable: _.var - vardyn: - description: A dynamic variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/60_0family_dynamic_1_1.sh b/tests/results/test_namespace/60_0family_dynamic_1_1.sh new file mode 100644 index 0000000..9d76810 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_1.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_1_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.adoc new file mode 100644 index 0000000..0623752 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.adoc @@ -0,0 +1,35 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_1_empty.json b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.json new file mode 100644 index 0000000..0d30cc9 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_1_1_empty.md b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.md new file mode 100644 index 0000000..142106b --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_1_1_empty.sh b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.sh new file mode 100644 index 0000000..44d17d5 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_1_1_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/results/test_namespace/60_0family_dynamic_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_empty.adoc new file mode 100644 index 0000000..be2ea9d --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_empty.adoc @@ -0,0 +1,30 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_empty.json b/tests/results/test_namespace/60_0family_dynamic_empty.json new file mode 100644 index 0000000..295e608 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynexample"], "names": ["dynexample"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynexample.var"], "names": ["var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_empty.md b/tests/results/test_namespace/60_0family_dynamic_empty.md new file mode 100644 index 0000000..19ca989 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable. | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_empty.sh b/tests/results/test_namespace/60_0family_dynamic_empty.sh new file mode 100644 index 0000000..c7f45fd --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_empty.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynexample.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.adoc b/tests/results/test_namespace/60_0family_dynamic_jinja_number.adoc similarity index 72% rename from tests/docs/base/60_0family_dynamic_jinja_number.adoc rename to tests/results/test_namespace/60_0family_dynamic_jinja_number.adoc index cc90e37..b9ebd07 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - 1 - - 2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family -var2: - description: a variable - default: - jinja: | - {{ rougail.dyn1.var }} - description: get the value of rougail.dyn1.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.json b/tests/results/test_namespace/60_0family_dynamic_jinja_number.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_jinja_number.json rename to tests/results/test_namespace/60_0family_dynamic_jinja_number.json diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number.md b/tests/results/test_namespace/60_0family_dynamic_jinja_number.md new file mode 100644 index 0000000..0c02594 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: 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. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number.sh b/tests/results/test_namespace/60_0family_dynamic_jinja_number.sh new file mode 100644 index 0000000..022af39 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + number standard mandatory unique A suffix variable. + multiple + Default: + + + • 1 + • 2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn1.var + rougail.dyn2.var + string standard mandatory A variable inside dynamic family. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable. + Default: get the value of + rougail.dyn1.var. + diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.adoc new file mode 100644 index 0000000..4156b32 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.adoc @@ -0,0 +1,47 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[number]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* 1 +* 2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__1__.var** + +**rougail.dyn__2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: val +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable. + +**Default**: get the value of rougail.dyn1.var. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.json b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.json new file mode 100644 index 0000000..902b51d --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "number"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": [1, 2]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dyn1", "rougail.dyn2"], "names": ["dyn1", "dyn2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dyn1.var", "rougail.dyn2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": "get the value of rougail.dyn1.var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.md b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.md new file mode 100644 index 0000000..35fc081 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- 1
- 2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: 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. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.sh b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.sh new file mode 100644 index 0000000..6f8584c --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_jinja_number_empty.sh @@ -0,0 +1,49 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + number standard unique multiple A suffix variable. + Examples: + + + • 1 + • 2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn1.var + rougail.dyn2.var + string standard mandatory A variable inside dynamic family. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable. + Default: get the value of + rougail.dyn1.var. + diff --git a/tests/docs/base/60_0family_dynamic_no_description.adoc b/tests/results/test_namespace/60_0family_dynamic_no_description.adoc similarity index 76% rename from tests/docs/base/60_0family_dynamic_no_description.adoc rename to tests/results/test_namespace/60_0family_dynamic_no_description.adoc index 234996c..d980913 100644 --- a/tests/docs/base/60_0family_dynamic_no_description.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_no_description.adoc @@ -1,20 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_no_description.json b/tests/results/test_namespace/60_0family_dynamic_no_description.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_no_description.json rename to tests/results/test_namespace/60_0family_dynamic_no_description.json diff --git a/tests/docs/base/60_0family_dynamic_no_description.md b/tests/results/test_namespace/60_0family_dynamic_no_description.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_no_description.md rename to tests/results/test_namespace/60_0family_dynamic_no_description.md index 1cfefd9..956fd99 100644 --- a/tests/docs/base/60_0family_dynamic_no_description.md +++ b/tests/results/test_namespace/60_0family_dynamic_no_description.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | diff --git a/tests/results/test_namespace/60_0family_dynamic_no_description.sh b/tests/results/test_namespace/60_0family_dynamic_no_description.sh new file mode 100644 index 0000000..adcaab2 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_no_description.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory Var. + diff --git a/tests/results/test_namespace/60_0family_dynamic_no_description_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.adoc new file mode 100644 index 0000000..f2c3efb --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.adoc @@ -0,0 +1,35 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +Var. +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_no_description_empty.json b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.json new file mode 100644 index 0000000..270172c --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_no_description_empty.md b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.md new file mode 100644 index 0000000..4dbe2ef --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/results/test_namespace/60_0family_dynamic_no_description_empty.sh b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.sh new file mode 100644 index 0000000..7fe36c6 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_no_description_empty.sh @@ -0,0 +1,36 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_0family_dynamic_static.adoc b/tests/results/test_namespace/60_0family_dynamic_static.adoc similarity index 67% rename from tests/docs/base/60_0family_dynamic_static.adoc rename to tests/results/test_namespace/60_0family_dynamic_static.adoc index 3495af7..e8bedd3 100644 --- a/tests/docs/base/60_0family_dynamic_static.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_static.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - var: # a variable inside a dynamic family ----- == Variables for "Rougail" === a dynamic family diff --git a/tests/docs/base/60_0family_dynamic_static.json b/tests/results/test_namespace/60_0family_dynamic_static.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_static.json rename to tests/results/test_namespace/60_0family_dynamic_static.json diff --git a/tests/docs/base/60_0family_dynamic_static.md b/tests/results/test_namespace/60_0family_dynamic_static.md similarity index 94% rename from tests/docs/base/60_0family_dynamic_static.md rename to tests/results/test_namespace/60_0family_dynamic_static.md index b03ad7b..3e30767 100644 --- a/tests/docs/base/60_0family_dynamic_static.md +++ b/tests/results/test_namespace/60_0family_dynamic_static.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - var: # a variable inside a dynamic family -``` # Variables for "Rougail" ## a dynamic family diff --git a/tests/results/test_namespace/60_0family_dynamic_static.sh b/tests/results/test_namespace/60_0family_dynamic_static.sh new file mode 100644 index 0000000..c102efc --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_static.sh @@ -0,0 +1,25 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                               Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A variable inside a dynamic family. + diff --git a/tests/docs/base/60_0family_dynamic_test.adoc b/tests/results/test_namespace/60_0family_dynamic_test.adoc similarity index 72% rename from tests/docs/base/60_0family_dynamic_test.adoc rename to tests/results/test_namespace/60_0family_dynamic_test.adoc index 4abe613..1c88e97 100644 --- a/tests/docs/base/60_0family_dynamic_test.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_test.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var: - description: A suffix variable - multi: true - test: - - val1 - - val2 - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - - var: # A dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_test.json b/tests/results/test_namespace/60_0family_dynamic_test.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_test.json rename to tests/results/test_namespace/60_0family_dynamic_test.json diff --git a/tests/docs/base/60_0family_dynamic_test.md b/tests/results/test_namespace/60_0family_dynamic_test.md similarity index 96% rename from tests/docs/base/60_0family_dynamic_test.md rename to tests/results/test_namespace/60_0family_dynamic_test.md index 7931ccd..2985a79 100644 --- a/tests/docs/base/60_0family_dynamic_test.md +++ b/tests/results/test_namespace/60_0family_dynamic_test.md @@ -2,26 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                    | Description                                                                                                                 | diff --git a/tests/results/test_namespace/60_0family_dynamic_test.sh b/tests/results/test_namespace/60_0family_dynamic_test.sh new file mode 100644 index 0000000..ce97253 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_test.sh @@ -0,0 +1,37 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory unique A suffix variable. + multiple + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_variable_empty.adoc similarity index 74% rename from tests/docs/base/60_0family_dynamic_variable_empty.adoc rename to tests/results/test_namespace/60_0family_dynamic_variable_empty.adoc index 6d84077..77a73c3 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_variable_empty.adoc @@ -1,16 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: [] # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.json b/tests/results/test_namespace/60_0family_dynamic_variable_empty.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_variable_empty.json rename to tests/results/test_namespace/60_0family_dynamic_variable_empty.json diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_empty.md b/tests/results/test_namespace/60_0family_dynamic_variable_empty.md new file mode 100644 index 0000000..15394d4 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable. | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: val | + diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_empty.sh b/tests/results/test_namespace/60_0family_dynamic_variable_empty.sh new file mode 100644 index 0000000..41b0374 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_empty.sh @@ -0,0 +1,31 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory unique A suffix variable. + multiple + + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynexample.var + string standard mandatory A variable inside dynamic family. + Default: val + diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.adoc similarity index 75% rename from tests/docs/base/60_0family_dynamic_variable_suffix.adoc rename to tests/results/test_namespace/60_0family_dynamic_variable_suffix.adoc index 91852dd..730f2fc 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.adoc @@ -1,18 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: a value # A dynamic variable with suffix {{ identifier }} ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.json b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.json similarity index 100% rename from tests/docs/base/60_0family_dynamic_variable_suffix.json rename to tests/results/test_namespace/60_0family_dynamic_variable_suffix.json diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix.md b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.md new file mode 100644 index 0000000..65b722f --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix.sh b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.sh new file mode 100644 index 0000000..a657fe7 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.adoc b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.adoc new file mode 100644 index 0000000..407bad0 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.adoc @@ -0,0 +1,37 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable with suffix __val1__. + +A dynamic variable with suffix __val2__. + +**Default**: a value +|==== + diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.json b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.json new file mode 100644 index 0000000..18f233b --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "a value", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable with suffix val1.", "A dynamic variable with suffix val2."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.md b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.md new file mode 100644 index 0000000..79e162a --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + diff --git a/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.sh b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.sh new file mode 100644 index 0000000..e54ea76 --- /dev/null +++ b/tests/results/test_namespace/60_0family_dynamic_variable_suffix_empty.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string basic mandatory unique A suffix variable. + multiple + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable with suffix val1. + A dynamic variable with suffix val2. + Default: a value + diff --git a/tests/results/test_namespace/60_0family_empty.adoc b/tests/results/test_namespace/60_0family_empty.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/60_0family_empty.json b/tests/results/test_namespace/60_0family_empty.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/60_0family_empty.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_empty.md b/tests/results/test_namespace/60_0family_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/60_0family_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/60_0family_empty.sh b/tests/results/test_namespace/60_0family_empty.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/60_0family_hidden.adoc b/tests/results/test_namespace/60_0family_hidden.adoc new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/test_namespace/60_0family_hidden.json b/tests/results/test_namespace/60_0family_hidden.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/tests/results/test_namespace/60_0family_hidden.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/tests/results/test_namespace/60_0family_hidden.md b/tests/results/test_namespace/60_0family_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace/60_0family_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace/60_0family_hidden.sh b/tests/results/test_namespace/60_0family_hidden.sh new file mode 100644 index 0000000..e69de29 diff --git a/tests/docs/base/60_0family_mode.adoc b/tests/results/test_namespace/60_0family_mode.adoc similarity index 64% rename from tests/docs/base/60_0family_mode.adoc rename to tests/results/test_namespace/60_0family_mode.adoc index 959ecc2..aeb71d7 100644 --- a/tests/docs/base/60_0family_mode.adoc +++ b/tests/results/test_namespace/60_0family_mode.adoc @@ -1,15 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -family: # a family - var: - description: A variable - mode: basic - default: non ----- == Variables for "Rougail" === a family diff --git a/tests/docs/base/60_0family_mode.json b/tests/results/test_namespace/60_0family_mode.json similarity index 100% rename from tests/docs/base/60_0family_mode.json rename to tests/results/test_namespace/60_0family_mode.json diff --git a/tests/results/test_namespace/60_0family_mode.md b/tests/results/test_namespace/60_0family_mode.md new file mode 100644 index 0000000..65dc69a --- /dev/null +++ b/tests/results/test_namespace/60_0family_mode.md @@ -0,0 +1,14 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + diff --git a/tests/results/test_namespace/60_0family_mode.sh b/tests/results/test_namespace/60_0family_mode.sh new file mode 100644 index 0000000..d601bcc --- /dev/null +++ b/tests/results/test_namespace/60_0family_mode.sh @@ -0,0 +1,18 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a family + +basic + + + + +  Variable                        Description                    + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.family.var + string basic mandatory A variable. + Default: non + diff --git a/tests/docs/base/60_1family_dynamic_jinja.adoc b/tests/results/test_namespace/60_1family_dynamic_jinja.adoc similarity index 67% rename from tests/docs/base/60_1family_dynamic_jinja.adoc rename to tests/results/test_namespace/60_1family_dynamic_jinja.adoc index 7c21c97..221e951 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.adoc +++ b/tests/results/test_namespace/60_1family_dynamic_jinja.adoc @@ -1,22 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - jinja: | - {% for val in _.var %} - {{ loop.index }} - {% endfor %} - description: index of suffix value - var: val # a dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_1family_dynamic_jinja.json b/tests/results/test_namespace/60_1family_dynamic_jinja.json similarity index 100% rename from tests/docs/base/60_1family_dynamic_jinja.json rename to tests/results/test_namespace/60_1family_dynamic_jinja.json diff --git a/tests/results/test_namespace/60_1family_dynamic_jinja.md b/tests/results/test_namespace/60_1family_dynamic_jinja.md new file mode 100644 index 0000000..849605e --- /dev/null +++ b/tests/results/test_namespace/60_1family_dynamic_jinja.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: index of suffix value. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + diff --git a/tests/results/test_namespace/60_1family_dynamic_jinja.sh b/tests/results/test_namespace/60_1family_dynamic_jinja.sh new file mode 100644 index 0000000..8d1a4a6 --- /dev/null +++ b/tests/results/test_namespace/60_1family_dynamic_jinja.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: index of suffix value. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn1.var + rougail.dyn2.var + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc similarity index 72% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc rename to tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc index 96c4917..0e41267 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - family: # a family - var: # with a variable -var2: - description: a second variable - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.json b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.json similarity index 100% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.json rename to tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.json diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.md b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.md new file mode 100644 index 0000000..8d8b84c --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +### a family + +`basic` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.sh b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.sh new file mode 100644 index 0000000..d68d672 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + a family + +basic + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc similarity index 69% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc rename to tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc index 2aa5fcb..bdbb5b5 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -1,29 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - family: - description: a family inside dynamic family - var: - description: a dynamic variable - default: - type: identifier -var2: - description: a varible outside dynamic family - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.json b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.json similarity index 100% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.json rename to tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.json diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md new file mode 100644 index 0000000..6af1a43 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the 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. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh new file mode 100644 index 0000000..4fd4ee0 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2.sh @@ -0,0 +1,54 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a family inside dynamic family + +standard + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc new file mode 100644 index 0000000..ab69c2a --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.adoc @@ -0,0 +1,51 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A identifier variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +==== a family inside dynamic family + +`standard` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.family.var** + +**rougail.dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A varible outside dynamic family. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.json b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.json new file mode 100644 index 0000000..12d8460 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.dynval1.family", "rougail.dynval2.family"], "names": ["family", "family"], "description": "a family inside dynamic family", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"paths": ["rougail.dynval1.family.var", "rougail.dynval2.family.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A varible outside dynamic family."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.md b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.md new file mode 100644 index 0000000..6de6414 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A varible outside dynamic family.
**Default**: the value of var. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh new file mode 100644 index 0000000..24e5ab1 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_2_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A identifier variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a family inside dynamic family + +standard + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string standard mandatory A dynamic variable. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard A varible outside dynamic family. + Default: the value of var. + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.adoc b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.adoc new file mode 100644 index 0000000..53d27a4 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.adoc @@ -0,0 +1,50 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +==== a family + +`basic` + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.family.var** + +**rougail.dyn__val2__.family.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +With a variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.json b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.json new file mode 100644 index 0000000..3cfd951 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"family": {"type": "family", "informations": {"paths": ["rougail.dynval1.family", "rougail.dynval2.family"], "names": ["family", "family"], "description": "a family", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"paths": ["rougail.dynval1.family.var", "rougail.dynval2.family.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["With a variable."]}}}}}, "var2": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.md b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.md new file mode 100644 index 0000000..63a6560 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +### a family + +`basic` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.sh b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.sh new file mode 100644 index 0000000..b0b3a84 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_jinja_fill_sub_group_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + a family + +basic + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string basic mandatory With a variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard A second variable. + Default: the value of var. + diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.adoc b/tests/results/test_namespace/60_2family_dynamic_outside_calc.adoc similarity index 73% rename from tests/docs/base/60_2family_dynamic_outside_calc.adoc rename to tests/results/test_namespace/60_2family_dynamic_outside_calc.adoc index 4c16259..dc84e9e 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.adoc +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc.adoc @@ -1,24 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: # a suffx variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - var: val # a dynamic variable -newvar: - description: a second variable - default: - jinja: | - {{ _.dynval1.var }} - description: the value of var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.json b/tests/results/test_namespace/60_2family_dynamic_outside_calc.json similarity index 100% rename from tests/docs/base/60_2family_dynamic_outside_calc.json rename to tests/results/test_namespace/60_2family_dynamic_outside_calc.json diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc.md b/tests/results/test_namespace/60_2family_dynamic_outside_calc.md new file mode 100644 index 0000000..01917dd --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc.sh b/tests/results/test_namespace/60_2family_dynamic_outside_calc.sh new file mode 100644 index 0000000..5276901 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc.sh @@ -0,0 +1,49 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A suffx variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.newvar + string standard mandatory A second variable. + Default: the value of var. + diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.adoc b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.adoc new file mode 100644 index 0000000..e1821f0 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.adoc @@ -0,0 +1,47 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffx variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.newvar** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A second variable. + +**Default**: the value of var. +|==== + diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.json b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.json new file mode 100644 index 0000000..4abc997 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffx variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "newvar": {"type": "variable", "default": "the value of var.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.newvar"], "names": ["newvar"], "descriptions": ["A second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.md b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.md new file mode 100644 index 0000000..146b8d6 --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffx variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + diff --git a/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.sh b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.sh new file mode 100644 index 0000000..f5b823d --- /dev/null +++ b/tests/results/test_namespace/60_2family_dynamic_outside_calc_empty.sh @@ -0,0 +1,48 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard unique multiple A suffx variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: val + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.newvar + string standard A second variable. + Default: the value of var. + diff --git a/tests/docs/base/60_5family_dynamic_calc2.adoc b/tests/results/test_namespace/60_5family_dynamic_calc2.adoc similarity index 71% rename from tests/docs/base/60_5family_dynamic_calc2.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc2.adoc index fa97824..2e014de 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc2.adoc @@ -1,29 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -var2: # a second variable - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - hidden: - jinja: | - {% if _.var2 == "no" %} - var2 is no - {% endif %} - description: if var2 is no - - vardyn: val # a dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_calc2.json b/tests/results/test_namespace/60_5family_dynamic_calc2.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc2.json rename to tests/results/test_namespace/60_5family_dynamic_calc2.json diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2.md b/tests/results/test_namespace/60_5family_dynamic_calc2.md new file mode 100644 index 0000000..636fb91 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + +## A dynamic family + +`standard` *`hidden`* + +**Hidden**: if var2 is no. + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2.sh b/tests/results/test_namespace/60_5family_dynamic_calc2.sh new file mode 100644 index 0000000..ef9ffd3 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2.sh @@ -0,0 +1,43 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | | rougail.var2 string basic mandatory + | A second variable. + | + + + A dynamic family + +standard hidden + +Hidden: if var2 is no. + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.adoc new file mode 100644 index 0000000..12483e7 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.adoc @@ -0,0 +1,44 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A second variable. +|==== + +=== A dynamic family + +`standard` `__hidden__` + + +**Hidden**: if var2 is no. + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.vardyn** + +**rougail.dyn__val2__.vardyn** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: val +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2_empty.json b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.json new file mode 100644 index 0000000..7967bd2 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "var2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A second variable."]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}, {"type": "property", "name": "hidden", "annotation": "if var2 is no."}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"vardyn": {"paths": ["rougail.dynval1.vardyn", "rougail.dynval2.vardyn"], "names": ["vardyn", "vardyn"], "type": "variable", "default": "val", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2_empty.md b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.md new file mode 100644 index 0000000..c04d51f --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + +## A dynamic family + +`standard` *`hidden`* + +**Hidden**: if var2 is no. + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc2_empty.sh b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.sh new file mode 100644 index 0000000..7c69c2b --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc2_empty.sh @@ -0,0 +1,42 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | | rougail.var2 string basic mandatory + | A second variable. + | + + + A dynamic family + +standard hidden + +Hidden: if var2 is no. + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string standard mandatory A dynamic variable. + Default: val + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.adoc similarity index 75% rename from tests/docs/base/60_5family_dynamic_calc_suffix.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix.adoc index 72c7c05..dd8fa6e 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.adoc @@ -1,28 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var1: - description: A suffix variable - default: - - val1 - - val2 - -dyn{{ identifier }}: - dynamic: - variable: _.var1 - - var: - description: A dynamic variable - -var2: - description: A variable calculated - default: - variable: rougail.dynval1.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc_suffix.json rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix.json diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.md new file mode 100644 index 0000000..78c9f64 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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". | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.sh new file mode 100644 index 0000000..44bf2bf --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix.sh @@ -0,0 +1,48 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: the value of the variable + "rougail.dynval1.var". + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.adoc similarity index 73% rename from tests/docs/base/60_5family_dynamic_calc_suffix2.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix2.adoc index 306ba62..e5f146a 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.adoc @@ -1,21 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: Suffix has value - default: - type: identifier ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc_suffix2.json rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix2.json diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.md new file mode 100644 index 0000000..24b2535 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.sh new file mode 100644 index 0000000..697a49a --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory Suffix has value. + Default: the value of the + identifier. + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.adoc new file mode 100644 index 0000000..487fb71 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.adoc @@ -0,0 +1,36 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Suffix has value. + +**Default**: the value of the identifier. +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.json new file mode 100644 index 0000000..1eb352f --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Suffix has value."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.md new file mode 100644 index 0000000..1654b7e --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.sh new file mode 100644 index 0000000..51e9de6 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix2_empty.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory Suffix has value. + Default: the value of the + identifier. + diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.adoc similarity index 68% rename from tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.adoc index b75f757..fbc71d1 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.adoc @@ -1,19 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -dyn{{ identifier }}: - dynamic: - - val1 - - val2 - var: - description: A dynamic variable - disabled: - type: identifier - when: val1 ----- == Variables for "Rougail" === rougail.dyn__val1__ or rougail.dyn__val2__ diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc_suffix_disabled.json rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.json diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.md similarity index 94% rename from tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.md index 4024829..acd7c56 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.md @@ -2,21 +2,6 @@ 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 for "Rougail" ## rougail.dyn*val1* or rougail.dyn*val2* diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.sh new file mode 100644 index 0000000..b42b212 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_disabled.sh @@ -0,0 +1,28 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory disabled A dynamic variable. + Disabled: when the identifier is + "val1". + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.adoc new file mode 100644 index 0000000..a287de6 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.adoc @@ -0,0 +1,49 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== rougail.dyn__val1__ or rougail.dyn__val2__ + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: + +* the value of the variable "rougail.dyn__val1__.var" +* the value of the variable "rougail.dyn__val2__.var" +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.json new file mode 100644 index 0000000..ddc4641 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.dynval1.var\"", "the value of the variable \"rougail.dynval2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.md new file mode 100644 index 0000000..8357f79 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.sh new file mode 100644 index 0000000..19f1969 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: + + + • the value of the variable "rougail.dynval1.var" + • the value of the variable "rougail.dynval2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.adoc similarity index 65% rename from tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.adoc index 9f2b3ad..f052bb3 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.adoc @@ -1,26 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - default: - jinja: | - {{ identifier }} - params: - identifier: - type: identifier - description: from suffix ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc_suffix_param.json rename to tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.json diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.md new file mode 100644 index 0000000..98801d4 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.sh new file mode 100644 index 0000000..d3dc0ce --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.adoc new file mode 100644 index 0000000..6b0da53 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.adoc @@ -0,0 +1,36 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A identifier variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A dynamic variable. + +**Default**: from suffix. +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.json b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.json new file mode 100644 index 0000000..0f0e957 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "from suffix.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.md b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.md new file mode 100644 index 0000000..92c39c0 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.sh b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.sh new file mode 100644 index 0000000..40c86fd --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_suffix_param_empty.sh @@ -0,0 +1,38 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A identifier variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory A dynamic variable. + Default: from suffix. + diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_variable.adoc similarity index 74% rename from tests/docs/base/60_5family_dynamic_calc_variable.adoc rename to tests/results/test_namespace/60_5family_dynamic_calc_variable.adoc index 49908fe..dd8fa6e 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var1: - description: A suffix variable - default: - - val1 - - val2 -dyn{{ identifier }}: - dynamic: - variable: _.var1 - propertyerror: false - var: - description: A dynamic variable -var2: - description: A variable calculated - default: - variable: _.dynval1.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.json b/tests/results/test_namespace/60_5family_dynamic_calc_variable.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_calc_variable.json rename to tests/results/test_namespace/60_5family_dynamic_calc_variable.json diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable.md b/tests/results/test_namespace/60_5family_dynamic_calc_variable.md new file mode 100644 index 0000000..78c9f64 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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". | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable.sh b/tests/results/test_namespace/60_5family_dynamic_calc_variable.sh new file mode 100644 index 0000000..44bf2bf --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable.sh @@ -0,0 +1,48 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: the value of the variable + "rougail.dynval1.var". + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.adoc new file mode 100644 index 0000000..a287de6 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.adoc @@ -0,0 +1,49 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== rougail.dyn__val1__ or rougail.dyn__val2__ + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +A dynamic variable. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable calculated. + +**Default**: + +* the value of the variable "rougail.dyn__val1__.var" +* the value of the variable "rougail.dyn__val2__.var" +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.json b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.json new file mode 100644 index 0000000..ddc4641 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var1"], "names": ["var1"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var1\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A dynamic variable."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.dynval1.var\"", "the value of the variable \"rougail.dynval2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable calculated."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.md b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.md new file mode 100644 index 0000000..8357f79 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.sh b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.sh new file mode 100644 index 0000000..19f1969 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_calc_variable_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var1 + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + rougail.dynval1 or rougail.dynval2 + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var1". + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string basic mandatory A dynamic variable. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable calculated. + Default: + + + • the value of the variable "rougail.dynval1.var" + • the value of the variable "rougail.dynval2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.adoc similarity index 60% rename from tests/docs/base/60_5family_dynamic_hidden_suffix.adoc rename to tests/results/test_namespace/60_5family_dynamic_hidden_suffix.adoc index 233d75c..51ea45e 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.adoc @@ -1,32 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - hidden: - jinja: | - {% if suffix == 'val2' %} - disabled - {% endif %} - params: - suffix: - type: identifier - description: if suffix == 'val2' - - var: - description: a variable - mandatory: false - family: # a family - var: - description: a new variable - mandatory: false ----- == Variables for "Rougail" === a dynamic family diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.json b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_hidden_suffix.json rename to tests/results/test_namespace/60_5family_dynamic_hidden_suffix.json diff --git a/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.md b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.md new file mode 100644 index 0000000..6c4515a --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a dynamic family + +`standard` *`hidden`* + +**Hidden**: if suffix == 'val2'. + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | + +### a family + +`standard` + +| Variable                                                                                       | Description                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.sh b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.sh new file mode 100644 index 0000000..8c84fee --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_hidden_suffix.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a dynamic family + +standard hidden + +Hidden: if suffix == 'val2'. + +This family builds families dynamically. + +Identifiers: + + • val1 + • val2 + + + + +  Variable                     Description                 + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard A variable. + + + a family + +standard + + + + +  Variable                            Description                        + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.family.var + rougail.dynval2.family.var + string standard A new variable. + diff --git a/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.adoc new file mode 100644 index 0000000..119c3f4 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.adoc @@ -0,0 +1,78 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +* val3 +* val4 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.__val1___dyn.var1** + +**rougail.__val2___dyn.var1** + +**rougail.__val3___dyn.var1** + +**rougail.__val4___dyn.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable 1. + +**Default**: the value of the identifier. +| + +**rougail.__val1___dyn.var2** + +**rougail.__val2___dyn.var2** + +**rougail.__val3___dyn.var2** + +**rougail.__val4___dyn.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable 2. + +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" +* the value of the variable "rougail.__val3___dyn.var1" +* the value of the variable "rougail.__val4___dyn.var1" +| + +**rougail.__val1___dyn.var3** + +**rougail.__val2___dyn.var3** + +**rougail.__val3___dyn.var3** + +**rougail.__val4___dyn.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable 3. + +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" +* the value of the variable "rougail.__val3___dyn.var1" +* the value of the variable "rougail.__val4___dyn.var1" +| + +**rougail.__val1___dyn.var4** + +**rougail.__val2___dyn.var4** + +**rougail.__val3___dyn.var4** + +**rougail.__val4___dyn.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `__disabled__` | +A variable 4. + +**Default**: the value of the variable "rougail.val4_dyn.var1". + +**Disabled**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.json b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.json new file mode 100644 index 0000000..6c9ee24 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2", "val3", "val4"]}, "{{ identifier }}_dyn": {"type": "dynamic", "informations": {"paths": ["rougail.val1_dyn", "rougail.val2_dyn", "rougail.val3_dyn", "rougail.val4_dyn"], "names": ["val1_dyn", "val2_dyn", "val3_dyn", "val4_dyn"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var1": {"paths": ["rougail.val1_dyn.var1", "rougail.val2_dyn.var1", "rougail.val3_dyn.var1", "rougail.val4_dyn.var1"], "names": ["var1", "var1", "var1", "var1"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable 1."]}, "var2": {"paths": ["rougail.val1_dyn.var2", "rougail.val2_dyn.var2", "rougail.val3_dyn.var2", "rougail.val4_dyn.var2"], "names": ["var2", "var2", "var2", "var2"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\"", "the value of the variable \"rougail.val3_dyn.var1\"", "the value of the variable \"rougail.val4_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable 2."]}, "var3": {"paths": ["rougail.val1_dyn.var3", "rougail.val2_dyn.var3", "rougail.val3_dyn.var3", "rougail.val4_dyn.var3"], "names": ["var3", "var3", "var3", "var3"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\"", "the value of the variable \"rougail.val3_dyn.var1\"", "the value of the variable \"rougail.val4_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable 3."]}, "var4": {"paths": ["rougail.val1_dyn.var4", "rougail.val2_dyn.var4", "rougail.val3_dyn.var4", "rougail.val4_dyn.var4"], "names": ["var4", "var4", "var4", "var4"], "type": "variable", "default": "the value of the variable \"rougail.val4_dyn.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "depends on a calculation."}], "descriptions": ["A variable 4."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.md b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.md new file mode 100644 index 0000000..b209c27 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2
- val3
- val4 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
**rougail.*val3*_dyn.var1**
**rougail.*val4*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 1.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**rougail.*val2*_dyn.var2**
**rougail.*val3*_dyn.var2**
**rougail.*val4*_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 2.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1"
- the value of the variable "rougail.*val3*_dyn.var1"
- the value of the variable "rougail.*val4*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**rougail.*val2*_dyn.var3**
**rougail.*val3*_dyn.var3**
**rougail.*val4*_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 3.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1"
- the value of the variable "rougail.*val3*_dyn.var1"
- the value of the variable "rougail.*val4*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**rougail.*val2*_dyn.var4**
**rougail.*val3*_dyn.var4**
**rougail.*val4*_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable 4.
**Default**: the value of the variable "rougail.val4_dyn.var1".
**Disabled**: depends on a calculation. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.sh b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.sh new file mode 100644 index 0000000..bcce636 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_unknown_suffix_empty.sh @@ -0,0 +1,73 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + • val3 + • val4 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.val1_dyn.var1 + rougail.val2_dyn.var1 + rougail.val3_dyn.var1 + rougail.val4_dyn.var1 + string standard mandatory A variable 1. + Default: the value of the + identifier. + rougail.val1_dyn.var2 + rougail.val2_dyn.var2 + rougail.val3_dyn.var2 + rougail.val4_dyn.var2 + string standard mandatory A variable 2. + Default: + + + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + • the value of the variable "rougail.val3_dyn.var1" + • the value of the variable "rougail.val4_dyn.var1" + | | rougail.val1_dyn.var3 rougail.val2_dyn.var3 rougail.val3_dyn.var3 + rougail.val4_dyn.var3 string standard mandatory + | A variable 3. Default: + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + • the value of the variable "rougail.val3_dyn.var1" + • the value of the variable "rougail.val4_dyn.var1" + | | rougail.val1_dyn.var4 rougail.val2_dyn.var4 rougail.val3_dyn.var4 + rougail.val4_dyn.var4 string standard mandatory disabled + | A variable 4. Default: the value of the variable "rougail.val4_dyn.var1". + Disabled: depends on a calculation. + | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside.adoc similarity index 72% rename from tests/docs/base/60_5family_dynamic_variable_outside.adoc rename to tests/results/test_namespace/60_5family_dynamic_variable_outside.adoc index e764687..21b7b44 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside.adoc @@ -1,27 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -var2: - description: a variable - multi: true - default: - variable: rougail.my_dyn_family_{{ identifier }}.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_variable_outside.json rename to tests/results/test_namespace/60_5family_dynamic_variable_outside.json diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside.md new file mode 100644 index 0000000..9b49ab0 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside.sh new file mode 100644 index 0000000..9385e1c --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside.sh @@ -0,0 +1,55 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.adoc similarity index 71% rename from tests/docs/base/60_5family_dynamic_variable_outside2.adoc rename to tests/results/test_namespace/60_5family_dynamic_variable_outside2.adoc index 36ebe36..a8080b4 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside2.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.adoc @@ -1,31 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' - -var2: - description: a variable - multi: true - default: - variable: rougail.my_dyn_family_{{ identifier }}.var - -var: # a suffix variable - - val1 - - val2 - -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_variable_outside2.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_variable_outside2.json rename to tests/results/test_namespace/60_5family_dynamic_variable_outside2.json diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.md new file mode 100644 index 0000000..6e78374 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A suffix variable.
**Default**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.sh new file mode 100644 index 0000000..794d10f --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2.sh @@ -0,0 +1,43 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | | rougail.var string standard mandatory unique multiple + | A suffix variable. Default: + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the identifier. + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.adoc new file mode 100644 index 0000000..ea5f967 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* the value of the variable "rougail.my_dyn_family___val1__.var" +* the value of the variable "rougail.my_dyn_family___val2__.var" +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Default**: the value of the identifier. +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.json new file mode 100644 index 0000000..f0992ef --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var2": {"type": "variable", "default": ["the value of the variable \"rougail.my_dyn_family_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}, "var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.md new file mode 100644 index 0000000..fce3a00 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.sh new file mode 100644 index 0000000..d490d41 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside2_empty.sh @@ -0,0 +1,43 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | | rougail.var string standard unique multiple + | A suffix variable. Examples: + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the identifier. + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.adoc new file mode 100644 index 0000000..9196262 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.adoc @@ -0,0 +1,50 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: + +* the value of the variable "rougail.my_dyn_family___val1__.var" +* the value of the variable "rougail.my_dyn_family___val2__.var" +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.json new file mode 100644 index 0000000..0bb085a --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.my_dyn_family_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.md new file mode 100644 index 0000000..7617064 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.sh new file mode 100644 index 0000000..d086438 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_empty.sh @@ -0,0 +1,54 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.adoc similarity index 66% rename from tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc rename to tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.adoc index 123d1ee..4d322c5 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.adoc @@ -1,33 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -var2: - description: a variable - multi: true - default: - jinja: |- - {%- for v in var %} - {{ v }} - {%- endfor -%} - params: - var: - variable: rougail.my_dyn_family_{{ identifier }}.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_variable_outside_jinja.json rename to tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.json diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.md new file mode 100644 index 0000000..adc15c7 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.sh new file mode 100644 index 0000000..2bcc6fb --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.adoc new file mode 100644 index 0000000..8110a09 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.adoc @@ -0,0 +1,47 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.my_dyn_family___val1__.var** + +**rougail.my_dyn_family___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable inside a dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.json new file mode 100644 index 0000000..07d8163 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.var", "rougail.my_dyn_family_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A variable inside a dynamic family."]}}}, "var2": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.md new file mode 100644 index 0000000..42ad1bb --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.sh new file mode 100644 index 0000000..617b095 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_jinja_empty.sh @@ -0,0 +1,50 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.var + rougail.my_dyn_family_val2.var + string standard A variable inside a dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory unique A variable. + multiple + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.adoc new file mode 100644 index 0000000..132ffdb --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.adoc @@ -0,0 +1,62 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +==== a sub dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.my_dyn_family___val1__.subdyn___val1__.var** + +**rougail.my_dyn_family___val1__.subdyn___val2__.var** + +**rougail.my_dyn_family___val2__.subdyn___val1__.var** + +**rougail.my_dyn_family___val2__.subdyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside a sub dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A variable. + +**Default**: + +* the value of the variable "rougail.my_dyn_family___val1__.subdyn___val1__.var" +* the value of the variable "rougail.my_dyn_family___val1__.subdyn___val2__.var" +* the value of the variable "rougail.my_dyn_family___val2__.subdyn___val1__.var" +* the value of the variable "rougail.my_dyn_family___val2__.subdyn___val2__.var" +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.json new file mode 100644 index 0000000..e686d63 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "my_dyn_family_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1", "rougail.my_dyn_family_val2"], "names": ["my_dyn_family_val1", "my_dyn_family_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"subdyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.my_dyn_family_val1.subdyn_val1", "rougail.my_dyn_family_val1.subdyn_val2", "rougail.my_dyn_family_val2.subdyn_val1", "rougail.my_dyn_family_val2.subdyn_val2"], "names": ["subdyn_val1", "subdyn_val2", "subdyn_val1", "subdyn_val2"], "description": "a sub dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.my_dyn_family_val1.subdyn_val1.var", "rougail.my_dyn_family_val1.subdyn_val2.var", "rougail.my_dyn_family_val2.subdyn_val1.var", "rougail.my_dyn_family_val2.subdyn_val2.var"], "names": ["var", "var", "var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside a sub dynamic family."]}}}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.my_dyn_family_val1.subdyn_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val1.subdyn_val2.var\"", "the value of the variable \"rougail.my_dyn_family_val2.subdyn_val1.var\"", "the value of the variable \"rougail.my_dyn_family_val2.subdyn_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.md new file mode 100644 index 0000000..795f3ad --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a sub dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.subdyn_*val1*.var**
**rougail.my_dyn_family_*val1*.subdyn_*val2*.var**
**rougail.my_dyn_family_*val2*.subdyn_*val1*.var**
**rougail.my_dyn_family_*val2*.subdyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside a sub dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A variable.
**Default**:
- the value of the variable "rougail.my_dyn_family_*val1*.subdyn_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val1*.subdyn_*val2*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.subdyn_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.subdyn_*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.sh new file mode 100644 index 0000000..eeb9ee1 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_sub_suffix_empty.sh @@ -0,0 +1,67 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a sub dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.my_dyn_family_val1.subdyn_va… + rougail.my_dyn_family_val1.subdyn_va… + rougail.my_dyn_family_val2.subdyn_va… + rougail.my_dyn_family_val2.subdyn_va… + string standard mandatory A variable inside a sub dynamic + family. + Default: the value of the identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard unique multiple A variable. + Default: + + + • the value of the variable "rougail.my_dyn_family_val1.subdyn_val1.var" + • the value of the variable "rougail.my_dyn_family_val1.subdyn_val2.var" + • the value of the variable "rougail.my_dyn_family_val2.subdyn_val1.var" + • the value of the variable "rougail.my_dyn_family_val2.subdyn_val2.var" + | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.adoc similarity index 74% rename from tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc rename to tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.adoc index 5801584..02c3087 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.adoc @@ -1,25 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside dynamic family - default: - type: identifier -var2: - description: a variable - default: - variable: _.dyn_val1.var ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.json similarity index 100% rename from tests/docs/base/60_5family_dynamic_variable_outside_suffix.json rename to tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.json diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.md new file mode 100644 index 0000000..135666a --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_*val1*.var**
**rougail.dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the 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". | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.sh new file mode 100644 index 0000000..8bfb6cd --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn_val1.var + rougail.dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard mandatory A variable. + Default: the value of the variable + "rougail.dyn_val1.var". + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.adoc b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.adoc new file mode 100644 index 0000000..b599d8b --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.adoc @@ -0,0 +1,50 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +Asuffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn___val1__.var** + +**rougail.dyn___val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable inside dynamic family. + +**Default**: the value of the identifier. +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A variable. + +**Default**: + +* the value of the variable "rougail.dyn___val1__.var" +* the value of the variable "rougail.dyn___val2__.var" +|==== + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.json b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.json new file mode 100644 index 0000000..71485e9 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["Asuffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dyn_val1", "rougail.dyn_val2"], "names": ["dyn_val1", "dyn_val2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dyn_val1.var", "rougail.dyn_val2.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable inside dynamic family."]}}}, "var2": {"type": "variable", "default": ["the value of the variable \"rougail.dyn_val1.var\"", "the value of the variable \"rougail.dyn_val2.var\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "paths": ["rougail.var2"], "names": ["var2"], "descriptions": ["A variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.md b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.md new file mode 100644 index 0000000..e0270a9 --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Asuffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_*val1*.var**
**rougail.dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**:
- the value of the variable "rougail.dyn_*val1*.var"
- the value of the variable "rougail.dyn_*val2*.var" | + diff --git a/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.sh b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.sh new file mode 100644 index 0000000..16d0b6d --- /dev/null +++ b/tests/results/test_namespace/60_5family_dynamic_variable_outside_suffix_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple Asuffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dyn_val1.var + rougail.dyn_val2.var + string standard mandatory A variable inside dynamic family. + Default: the value of the + identifier. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var2 + string standard A variable. + Default: + + + • the value of the variable "rougail.dyn_val1.var" + • the value of the variable "rougail.dyn_val2.var" + | diff --git a/tests/docs/base/60_6family_dynamic_inside.adoc b/tests/results/test_namespace/60_6family_dynamic_inside.adoc similarity index 74% rename from tests/docs/base/60_6family_dynamic_inside.adoc rename to tests/results/test_namespace/60_6family_dynamic_inside.adoc index e3cb4da..77b2730 100644 --- a/tests/docs/base/60_6family_dynamic_inside.adoc +++ b/tests/results/test_namespace/60_6family_dynamic_inside.adoc @@ -1,34 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 - -'{{ identifier }}_dyn': - description: a dynamic family - dynamic: - variable: _.var - var1: - description: value is suffix - default: - type: identifier - var2: - description: value is first variable - default: - variable: rougail.{{ identifier }}_dyn.var1 - var3: - description: value is relative first variable - default: - variable: _.var1 - var4: - description: value is first variable of val1 - default: - variable: rougail.val1_dyn.var1 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_6family_dynamic_inside.json b/tests/results/test_namespace/60_6family_dynamic_inside.json similarity index 100% rename from tests/docs/base/60_6family_dynamic_inside.json rename to tests/results/test_namespace/60_6family_dynamic_inside.json diff --git a/tests/results/test_namespace/60_6family_dynamic_inside.md b/tests/results/test_namespace/60_6family_dynamic_inside.md new file mode 100644 index 0000000..45a9559 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**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". | + diff --git a/tests/results/test_namespace/60_6family_dynamic_inside.sh b/tests/results/test_namespace/60_6family_dynamic_inside.sh new file mode 100644 index 0000000..2afec60 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside.sh @@ -0,0 +1,58 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.val1_dyn.var1 + rougail.val2_dyn.var1 + string standard mandatory Value is suffix. + Default: the value of the + identifier. + rougail.val1_dyn.var2 + rougail.val2_dyn.var2 + string standard mandatory Value is first variable. + Default: + + + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var3 rougail.val2_dyn.var3 string standard mandatory + | Value is relative first variable. Default: + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var4 rougail.val2_dyn.var4 string standard mandatory + | Value is first variable of val1. Default: the value of the variable + "rougail.val1_dyn.var1". + | diff --git a/tests/results/test_namespace/60_6family_dynamic_inside_empty.adoc b/tests/results/test_namespace/60_6family_dynamic_inside_empty.adoc new file mode 100644 index 0000000..7e5c776 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside_empty.adoc @@ -0,0 +1,63 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.__val1___dyn.var1** + +**rougail.__val2___dyn.var1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Value is suffix. + +**Default**: the value of the identifier. +| + +**rougail.__val1___dyn.var2** + +**rougail.__val2___dyn.var2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Value is first variable. + +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" +| + +**rougail.__val1___dyn.var3** + +**rougail.__val2___dyn.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Value is relative first variable. + +**Default**: + +* the value of the variable "rougail.__val1___dyn.var1" +* the value of the variable "rougail.__val2___dyn.var1" +| + +**rougail.__val1___dyn.var4** + +**rougail.__val2___dyn.var4** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Value is first variable of val1. + +**Default**: the value of the variable "rougail.val1_dyn.var1". +|==== + diff --git a/tests/results/test_namespace/60_6family_dynamic_inside_empty.json b/tests/results/test_namespace/60_6family_dynamic_inside_empty.json new file mode 100644 index 0000000..2a40149 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "{{ identifier }}_dyn": {"type": "dynamic", "informations": {"paths": ["rougail.val1_dyn", "rougail.val2_dyn"], "names": ["val1_dyn", "val2_dyn"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var1": {"paths": ["rougail.val1_dyn.var1", "rougail.val2_dyn.var1"], "names": ["var1", "var1"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is suffix."]}, "var2": {"paths": ["rougail.val1_dyn.var2", "rougail.val2_dyn.var2"], "names": ["var2", "var2"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is first variable."]}, "var3": {"paths": ["rougail.val1_dyn.var3", "rougail.val2_dyn.var3"], "names": ["var3", "var3"], "type": "variable", "default": ["the value of the variable \"rougail.val1_dyn.var1\"", "the value of the variable \"rougail.val2_dyn.var1\""], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is relative first variable."]}, "var4": {"paths": ["rougail.val1_dyn.var4", "rougail.val2_dyn.var4"], "names": ["var4", "var4"], "type": "variable", "default": "the value of the variable \"rougail.val1_dyn.var1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Value is first variable of val1."]}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_6family_dynamic_inside_empty.md b/tests/results/test_namespace/60_6family_dynamic_inside_empty.md new file mode 100644 index 0000000..e66d7f1 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside_empty.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**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". | + diff --git a/tests/results/test_namespace/60_6family_dynamic_inside_empty.sh b/tests/results/test_namespace/60_6family_dynamic_inside_empty.sh new file mode 100644 index 0000000..6b4b64f --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_inside_empty.sh @@ -0,0 +1,57 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.val1_dyn.var1 + rougail.val2_dyn.var1 + string standard mandatory Value is suffix. + Default: the value of the + identifier. + rougail.val1_dyn.var2 + rougail.val2_dyn.var2 + string standard mandatory Value is first variable. + Default: + + + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var3 rougail.val2_dyn.var3 string standard mandatory + | Value is relative first variable. Default: + • the value of the variable "rougail.val1_dyn.var1" + • the value of the variable "rougail.val2_dyn.var1" + | | rougail.val1_dyn.var4 rougail.val2_dyn.var4 string standard mandatory + | Value is first variable of val1. Default: the value of the variable + "rougail.val1_dyn.var1". + | diff --git a/tests/docs/base/60_6family_dynamic_leadership.adoc b/tests/results/test_namespace/60_6family_dynamic_leadership.adoc similarity index 73% rename from tests/docs/base/60_6family_dynamic_leadership.adoc rename to tests/results/test_namespace/60_6family_dynamic_leadership.adoc index 624f2fe..f16e05a 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.adoc +++ b/tests/results/test_namespace/60_6family_dynamic_leadership.adoc @@ -1,29 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - leadership: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mandatory: false ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_6family_dynamic_leadership.json b/tests/results/test_namespace/60_6family_dynamic_leadership.json similarity index 100% rename from tests/docs/base/60_6family_dynamic_leadership.json rename to tests/results/test_namespace/60_6family_dynamic_leadership.json diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership.md b/tests/results/test_namespace/60_6family_dynamic_leadership.md new file mode 100644 index 0000000..58dd7fb --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.leadership.leader**
**rougail.dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dyn*val1*.leadership.follower1**
**rougail.dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.dyn*val1*.leadership.follower2**
**rougail.dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership.sh b/tests/results/test_namespace/60_6family_dynamic_leadership.sh new file mode 100644 index 0000000..6218cfc --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership.sh @@ -0,0 +1,54 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A suffix variable. + multiple + Default: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.leadership.leader + rougail.dynval2.leadership.leader + string basic mandatory unique A leader. + multiple + rougail.dynval1.leadership.follower1 + rougail.dynval2.leadership.follower1 + string standard A follower1. + rougail.dynval1.leadership.follower2 + rougail.dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership_empty.adoc b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.adoc new file mode 100644 index 0000000..a308fdc --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.adoc @@ -0,0 +1,53 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A suffix variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +==== a leadership + +`basic` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.leadership.leader** + +**rougail.dyn__val2__.leadership.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `unique` `multiple` | +A leader. +| + +**rougail.dyn__val1__.leadership.follower1** + +**rougail.dyn__val2__.leadership.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower1. +| + +**rougail.dyn__val1__.leadership.follower2** + +**rougail.dyn__val2__.leadership.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` | +A follower2. +|==== + diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership_empty.json b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.json new file mode 100644 index 0000000..fe86437 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A suffix variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "a dynamic family", "properties": [{"type": "mode", "name": "basic"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"leadership": {"type": "leadership", "informations": {"paths": ["rougail.dynval1.leadership", "rougail.dynval2.leadership"], "names": ["leadership", "leadership"], "description": "a leadership", "properties": [{"type": "mode", "name": "basic"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"paths": ["rougail.dynval1.leadership.leader", "rougail.dynval2.leadership.leader"], "names": ["leader", "leader"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A leader."], "multiple": true}, "follower1": {"paths": ["rougail.dynval1.leadership.follower1", "rougail.dynval2.leadership.follower1"], "names": ["follower1", "follower1"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower1."]}, "follower2": {"paths": ["rougail.dynval1.leadership.follower2", "rougail.dynval2.leadership.follower2"], "names": ["follower2", "follower2"], "type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}], "descriptions": ["A follower2."]}}}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership_empty.md b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.md new file mode 100644 index 0000000..0e5eb61 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.md @@ -0,0 +1,30 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.leadership.leader**
**rougail.dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dyn*val1*.leadership.follower1**
**rougail.dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.dyn*val1*.leadership.follower2**
**rougail.dyn*val2*.leadership.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower2. | + diff --git a/tests/results/test_namespace/60_6family_dynamic_leadership_empty.sh b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.sh new file mode 100644 index 0000000..5b14705 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_leadership_empty.sh @@ -0,0 +1,53 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A suffix variable. + Examples: + + + • val1 + • val2 + | + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + a leadership + +basic + +This family contains lists of variable blocks. + + + + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.leadership.leader + rougail.dynval2.leadership.leader + string basic mandatory unique A leader. + multiple + rougail.dynval1.leadership.follower1 + rougail.dynval2.leadership.follower1 + string standard A follower1. + rougail.dynval1.leadership.follower2 + rougail.dynval2.leadership.follower2 + string standard A follower2. + diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.adoc similarity index 67% rename from tests/docs/base/60_6family_dynamic_sub_dynamic.adoc rename to tests/results/test_namespace/60_6family_dynamic_sub_dynamic.adoc index 848f769..28be3ed 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.adoc @@ -1,52 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - multi: true - default: - jinja: | - {% for val in __.var %} - t{{ val }} - {% endfor %} - description: add 't' to each var value - dyn_{{ identifier }}: - description: a Second dynamic variable - dynamic: - variable: rougail.dyn{{ identifier }}.var - var: - description: A variable dynamic - default: - type: identifier - var_identifier: - description: identifier from first family - default: - type: identifier - identifier: 0 - var_identifiers: - description: merge identifiers - default: - jinja: | - {{ s1 }}-{{ s2 }} - params: - s1: - type: identifier - identifier: 0 - s2: - type: identifier - identifier: 1 - description: join identifier 1 et identifier 2 ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.json b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.json similarity index 100% rename from tests/docs/base/60_6family_dynamic_sub_dynamic.json rename to tests/results/test_namespace/60_6family_dynamic_sub_dynamic.json diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.md b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.md new file mode 100644 index 0000000..6d99115 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.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. | + +### a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**:
- the value of the variable "rougail.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*tval1*.var**
**rougail.dyn*val1*.dyn_*tval2*.var**
**rougail.dyn*val2*.dyn_*tval1*.var**
**rougail.dyn*val2*.dyn_*tval2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifier**
**rougail.dyn*val1*.dyn_*tval2*.var_identifier**
**rougail.dyn*val2*.dyn_*tval1*.var_identifier**
**rougail.dyn*val2*.dyn_*tval2*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val1*.dyn_*tval2*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval2*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.sh b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.sh new file mode 100644 index 0000000..5da0bdd --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic.sh @@ -0,0 +1,92 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory unique A dynamic variable. + multiple + Default: add 't' to each var value. + + + a Second dynamic variable + +standard + +This family builds families dynamically. + +Identifiers: + + • the value of the variable "rougail.dynval1.var" + • the value of the variable "rougail.dynval2.var" + + + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.dyn_tval1.var + rougail.dynval1.dyn_tval2.var + rougail.dynval2.dyn_tval1.var + rougail.dynval2.dyn_tval2.var + string standard mandatory A variable dynamic. + Default: the value of the + identifier. + rougail.dynval1.dyn_tval1.var_ident… + rougail.dynval1.dyn_tval2.var_ident… + rougail.dynval2.dyn_tval1.var_ident… + rougail.dynval2.dyn_tval2.var_ident… + string standard mandatory Identifier from first family. + Default: the value of the + identifier. + rougail.dynval1.dyn_tval1.var_ident… + rougail.dynval1.dyn_tval2.var_ident… + rougail.dynval2.dyn_tval1.var_ident… + rougail.dynval2.dyn_tval2.var_ident… + string standard mandatory Merge identifiers. + Default: join identifier 1 et + identifier 2. + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.adoc b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.adoc new file mode 100644 index 0000000..84d6506 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.adoc @@ -0,0 +1,76 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A identifier variable. + +**Default**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A dynamic variable. + +**Default**: add 't' to each var value. +|==== + +==== a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.dyn{{ suffix }}.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.dyn___tval1__.var** + +**rougail.dyn__val1__.dyn___tval2__.var** + +**rougail.dyn__val2__.dyn___tval1__.var** + +**rougail.dyn__val2__.dyn___tval2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable dynamic. + +**Default**: the value of the identifier. +| + +**rougail.dyn__val1__.dyn___tval1__.var_identifier** + +**rougail.dyn__val1__.dyn___tval2__.var_identifier** + +**rougail.dyn__val2__.dyn___tval1__.var_identifier** + +**rougail.dyn__val2__.dyn___tval2__.var_identifier** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Identifier from first family. + +**Default**: the value of the identifier. +| + +**rougail.dyn__val1__.dyn___tval1__.var_identifiers** + +**rougail.dyn__val1__.dyn___tval2__.var_identifiers** + +**rougail.dyn__val2__.dyn___tval1__.var_identifiers** + +**rougail.dyn__val2__.dyn___tval2__.var_identifiers** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Merge identifiers. + +**Default**: join identifier 1 et identifier 2. +|==== + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.json b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.json new file mode 100644 index 0000000..183828b --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "default": ["val1", "val2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "add 't' to each var value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A dynamic variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1.dyn_tval1", "rougail.dynval1.dyn_tval2", "rougail.dynval2.dyn_tval1", "rougail.dynval2.dyn_tval2"], "names": ["dyn_tval1", "dyn_tval2", "dyn_tval1", "dyn_tval2"], "description": "a Second dynamic variable", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.dyn{{ suffix }}.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.dyn_tval1.var", "rougail.dynval1.dyn_tval2.var", "rougail.dynval2.dyn_tval1.var", "rougail.dynval2.dyn_tval2.var"], "names": ["var", "var", "var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable dynamic."]}, "var_identifier": {"paths": ["rougail.dynval1.dyn_tval1.var_identifier", "rougail.dynval1.dyn_tval2.var_identifier", "rougail.dynval2.dyn_tval1.var_identifier", "rougail.dynval2.dyn_tval2.var_identifier"], "names": ["var_identifier", "var_identifier", "var_identifier", "var_identifier"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Identifier from first family."]}, "var_identifiers": {"paths": ["rougail.dynval1.dyn_tval1.var_identifiers", "rougail.dynval1.dyn_tval2.var_identifiers", "rougail.dynval2.dyn_tval1.var_identifiers", "rougail.dynval2.dyn_tval2.var_identifiers"], "names": ["var_identifiers", "var_identifiers", "var_identifiers", "var_identifiers"], "type": "variable", "default": "join identifier 1 et identifier 2.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Merge identifiers."]}}}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.md b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.md new file mode 100644 index 0000000..01fe19c --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.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. | + +### a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.dyn{{ suffix }}.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*tval1*.var**
**rougail.dyn*val1*.dyn_*tval2*.var**
**rougail.dyn*val2*.dyn_*tval1*.var**
**rougail.dyn*val2*.dyn_*tval2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifier**
**rougail.dyn*val1*.dyn_*tval2*.var_identifier**
**rougail.dyn*val2*.dyn_*tval1*.var_identifier**
**rougail.dyn*val2*.dyn_*tval2*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val1*.dyn_*tval2*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval2*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.sh b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.sh new file mode 100644 index 0000000..0cd9c3a --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_1_0.sh @@ -0,0 +1,89 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A identifier variable. + multiple + Default: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory unique A dynamic variable. + multiple + Default: add 't' to each var value. + + + a Second dynamic variable + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.dyn{{ suffix }}.var". + + + + + + + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.dyn_tval1.var + rougail.dynval1.dyn_tval2.var + rougail.dynval2.dyn_tval1.var + rougail.dynval2.dyn_tval2.var + string standard mandatory A variable dynamic. + Default: the value of the + identifier. + rougail.dynval1.dyn_tval1.var_ident… + rougail.dynval1.dyn_tval2.var_ident… + rougail.dynval2.dyn_tval1.var_ident… + rougail.dynval2.dyn_tval2.var_ident… + string standard mandatory Identifier from first family. + Default: the value of the + identifier. + rougail.dynval1.dyn_tval1.var_ident… + rougail.dynval1.dyn_tval2.var_ident… + rougail.dynval2.dyn_tval1.var_ident… + rougail.dynval2.dyn_tval2.var_ident… + string standard mandatory Merge identifiers. + Default: join identifier 1 et + identifier 2. + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.adoc b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.adoc new file mode 100644 index 0000000..a00bff3 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.adoc @@ -0,0 +1,73 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `unique` `multiple` | +A identifier variable. + +**Examples**: + +* val1 +* val2 +|==== + +=== A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.var** + +**rougail.dyn__val2__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A dynamic variable. + +**Default**: add 't' to each var value. +|==== + +==== a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**: + +* the value of the variable "rougail.dyn__val1__.var" +* the value of the variable "rougail.dyn__val2__.var" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.dyn__val1__.dyn___example__.var** + +**rougail.dyn__val2__.dyn___example__.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A variable dynamic. + +**Default**: the value of the identifier. +| + +**rougail.dyn__val1__.dyn___example__.var_identifier** + +**rougail.dyn__val2__.dyn___example__.var_identifier** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Identifier from first family. + +**Default**: the value of the identifier. +| + +**rougail.dyn__val1__.dyn___example__.var_identifiers** + +**rougail.dyn__val2__.dyn___example__.var_identifiers** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +Merge identifiers. + +**Default**: join identifier 1 et identifier 2. +|==== + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.json b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.json new file mode 100644 index 0000000..cf0103f --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"var": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.var"], "names": ["var"], "descriptions": ["A identifier variable."], "multiple": true, "examples": ["val1", "val2"]}, "dyn{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1", "rougail.dynval2"], "names": ["dynval1", "dynval2"], "description": "A dynamic family", "properties": [{"type": "mode", "name": "standard"}], "identifiers": "the value of the variable \"rougail.var\".", "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.var", "rougail.dynval2.var"], "names": ["var", "var"], "type": "variable", "default": "add 't' to each var value.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "descriptions": ["A dynamic variable."], "multiple": true}, "dyn_{{ identifier }}": {"type": "dynamic", "informations": {"paths": ["rougail.dynval1.dyn_example", "rougail.dynval2.dyn_example"], "names": ["dyn_example", "dyn_example"], "description": "a Second dynamic variable", "properties": [{"type": "mode", "name": "standard"}], "identifiers": ["the value of the variable \"rougail.dynval1.var\"", "the value of the variable \"rougail.dynval2.var\""], "help": ["This family builds families dynamically."]}, "children": {"var": {"paths": ["rougail.dynval1.dyn_example.var", "rougail.dynval2.dyn_example.var"], "names": ["var", "var"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["A variable dynamic."]}, "var_identifier": {"paths": ["rougail.dynval1.dyn_example.var_identifier", "rougail.dynval2.dyn_example.var_identifier"], "names": ["var_identifier", "var_identifier"], "type": "variable", "default": "the value of the identifier.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Identifier from first family."]}, "var_identifiers": {"paths": ["rougail.dynval1.dyn_example.var_identifiers", "rougail.dynval2.dyn_example.var_identifiers"], "names": ["var_identifiers", "var_identifiers"], "type": "variable", "default": "join identifier 1 et identifier 2.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "descriptions": ["Merge identifiers."]}}}}}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.md b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.md new file mode 100644 index 0000000..4b95afd --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | + +### a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**:
- the value of the variable "rougail.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*example*.var**
**rougail.dyn*val2*.dyn_*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*example*.var_identifier**
**rougail.dyn*val2*.dyn_*example*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*example*.var_identifiers**
**rougail.dyn*val2*.dyn_*example*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | + diff --git a/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.sh b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.sh new file mode 100644 index 0000000..61a7c83 --- /dev/null +++ b/tests/results/test_namespace/60_6family_dynamic_sub_dynamic_empty.sh @@ -0,0 +1,79 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard unique multiple A identifier variable. + Examples: + + + • val1 + • val2 + | + + + A dynamic family + +standard + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.var + rougail.dynval2.var + string standard mandatory unique A dynamic variable. + multiple + Default: add 't' to each var value. + + + a Second dynamic variable + +standard + +This family builds families dynamically. + +Identifiers: + + • the value of the variable "rougail.dynval1.var" + • the value of the variable "rougail.dynval2.var" + + + + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.dyn_example.var + rougail.dynval2.dyn_example.var + string standard mandatory A variable dynamic. + Default: the value of the + identifier. + rougail.dynval1.dyn_example.var_ide… + rougail.dynval2.dyn_example.var_ide… + string standard mandatory Identifier from first family. + Default: the value of the + identifier. + rougail.dynval1.dyn_example.var_ide… + rougail.dynval2.dyn_example.var_ide… + string standard mandatory Merge identifiers. + Default: join identifier 1 et + identifier 2. + diff --git a/tests/docs/base/60_9extra_dynamic.adoc b/tests/results/test_namespace/60_9extra_dynamic.adoc similarity index 74% rename from tests/docs/base/60_9extra_dynamic.adoc rename to tests/results/test_namespace/60_9extra_dynamic.adoc index dd2f993..690d6ec 100644 --- a/tests/docs/base/60_9extra_dynamic.adoc +++ b/tests/results/test_namespace/60_9extra_dynamic.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -var: # a variable - - a ----- -== dictionaries/extra/00-base.yml - -[,yaml] ----- ---- -version: 1.1 -dyn_{{ identifier }}: - dynamic: - variable: rougail.var - var: ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_9extra_dynamic.json b/tests/results/test_namespace/60_9extra_dynamic.json similarity index 100% rename from tests/docs/base/60_9extra_dynamic.json rename to tests/results/test_namespace/60_9extra_dynamic.json diff --git a/tests/results/test_namespace/60_9extra_dynamic.md b/tests/results/test_namespace/60_9extra_dynamic.md new file mode 100644 index 0000000..b2b1fd8 --- /dev/null +++ b/tests/results/test_namespace/60_9extra_dynamic.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: a | + +# Variables for "extra" + +## extra.dyn_*a* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/results/test_namespace/60_9extra_dynamic.sh b/tests/results/test_namespace/60_9extra_dynamic.sh new file mode 100644 index 0000000..bab93ad --- /dev/null +++ b/tests/results/test_namespace/60_9extra_dynamic.sh @@ -0,0 +1,35 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory unique A variable. + multiple + Default: a + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + extra.dyn_a + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "rougail.var". + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.dyn_a.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_9extra_dynamic_extra.adoc b/tests/results/test_namespace/60_9extra_dynamic_extra.adoc similarity index 72% rename from tests/docs/base/60_9extra_dynamic_extra.adoc rename to tests/results/test_namespace/60_9extra_dynamic_extra.adoc index 9a60a17..c7dd627 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.adoc +++ b/tests/results/test_namespace/60_9extra_dynamic_extra.adoc @@ -1,31 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -general: - description: général - varname: - type: string - description: No change - multi: true - default: - - a -version: '1.0' ----- -== dictionaries/extra/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: # a varaible - - a -dyn_{{ identifier }}: - dynamic: - variable: _.var - var: ----- == Variables for "Rougail" === général diff --git a/tests/docs/base/60_9extra_dynamic_extra.json b/tests/results/test_namespace/60_9extra_dynamic_extra.json similarity index 100% rename from tests/docs/base/60_9extra_dynamic_extra.json rename to tests/results/test_namespace/60_9extra_dynamic_extra.json diff --git a/tests/results/test_namespace/60_9extra_dynamic_extra.md b/tests/results/test_namespace/60_9extra_dynamic_extra.md new file mode 100644 index 0000000..192a233 --- /dev/null +++ b/tests/results/test_namespace/60_9extra_dynamic_extra.md @@ -0,0 +1,32 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +# Variables for "extra" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A varaible.
**Default**: a | + +## extra.dyn_*a* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "extra.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + diff --git a/tests/results/test_namespace/60_9extra_dynamic_extra.sh b/tests/results/test_namespace/60_9extra_dynamic_extra.sh new file mode 100644 index 0000000..d9075ff --- /dev/null +++ b/tests/results/test_namespace/60_9extra_dynamic_extra.sh @@ -0,0 +1,51 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + général + +standard + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.general.varname + string standard mandatory unique No change. + multiple + Default: a + + +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "extra" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.var + string standard mandatory unique A varaible. + multiple + Default: a + + + + extra.dyn_a + +basic + +This family builds families dynamically. + +Identifiers: the value of the variable "extra.var". + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + extra.dyn_a.var + string basic mandatory Var. + diff --git a/tests/docs/base/60_9family_dynamic_calc_both.adoc b/tests/results/test_namespace/60_9family_dynamic_calc_both.adoc similarity index 74% rename from tests/docs/base/60_9family_dynamic_calc_both.adoc rename to tests/results/test_namespace/60_9family_dynamic_calc_both.adoc index e6ab818..274fac8 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.adoc +++ b/tests/results/test_namespace/60_9family_dynamic_calc_both.adoc @@ -1,17 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.1' -var: val2 # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - variable: _.var - vardyn: # a dynamic variable ----- == Variables for "Rougail" [cols="1a,1a"] diff --git a/tests/docs/base/60_9family_dynamic_calc_both.json b/tests/results/test_namespace/60_9family_dynamic_calc_both.json similarity index 100% rename from tests/docs/base/60_9family_dynamic_calc_both.json rename to tests/results/test_namespace/60_9family_dynamic_calc_both.json diff --git a/tests/docs/base/60_9family_dynamic_calc_both.md b/tests/results/test_namespace/60_9family_dynamic_calc_both.md similarity index 97% rename from tests/docs/base/60_9family_dynamic_calc_both.md rename to tests/results/test_namespace/60_9family_dynamic_calc_both.md index e7ae3d2..c422936 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.md +++ b/tests/results/test_namespace/60_9family_dynamic_calc_both.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: val2 # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - variable: _.var - vardyn: # a dynamic variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | diff --git a/tests/results/test_namespace/60_9family_dynamic_calc_both.sh b/tests/results/test_namespace/60_9family_dynamic_calc_both.sh new file mode 100644 index 0000000..da8f9a4 --- /dev/null +++ b/tests/results/test_namespace/60_9family_dynamic_calc_both.sh @@ -0,0 +1,35 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.var + string standard mandatory A suffix variable. + Default: val2 + + + + a dynamic family + +basic + +This family builds families dynamically. + +Identifiers: + + • val1 + • the value of the variable "rougail.var". + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.dynval1.vardyn + rougail.dynval2.vardyn + string basic mandatory A dynamic variable. + diff --git a/tests/docs/base/68_0family_leadership_mode.adoc b/tests/results/test_namespace/68_0family_leadership_mode.adoc similarity index 68% rename from tests/docs/base/68_0family_leadership_mode.adoc rename to tests/results/test_namespace/68_0family_leadership_mode.adoc index 266217d..c617701 100644 --- a/tests/docs/base/68_0family_leadership_mode.adoc +++ b/tests/results/test_namespace/68_0family_leadership_mode.adoc @@ -1,23 +1,3 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- ---- -version: '1.0' -leader: - description: A leadership - type: leadership - leader: - description: A leader - multi: true - mandatory: false - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mode: basic ----- == Variables for "Rougail" === A leadership diff --git a/tests/docs/base/68_0family_leadership_mode.json b/tests/results/test_namespace/68_0family_leadership_mode.json similarity index 100% rename from tests/docs/base/68_0family_leadership_mode.json rename to tests/results/test_namespace/68_0family_leadership_mode.json diff --git a/tests/results/test_namespace/68_0family_leadership_mode.md b/tests/results/test_namespace/68_0family_leadership_mode.md new file mode 100644 index 0000000..bcf640b --- /dev/null +++ b/tests/results/test_namespace/68_0family_leadership_mode.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## A leadership + +`basic` + +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. | + diff --git a/tests/results/test_namespace/68_0family_leadership_mode.sh b/tests/results/test_namespace/68_0family_leadership_mode.sh new file mode 100644 index 0000000..6c2c2e2 --- /dev/null +++ b/tests/results/test_namespace/68_0family_leadership_mode.sh @@ -0,0 +1,24 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + A leadership + +basic + +This family contains lists of variable blocks. + + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.leader.leader + string basic unique multiple A leader. + rougail.leader.follower1 + string standard A follower1. + rougail.leader.follower2 + string basic mandatory A follower2. + diff --git a/tests/results/test_namespace_examples/00_0empty.md b/tests/results/test_namespace_examples/00_0empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/00_0empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/00_0version_underscore.md b/tests/results/test_namespace_examples/00_0version_underscore.md new file mode 100644 index 0000000..366b7c7 --- /dev/null +++ b/tests/results/test_namespace_examples/00_0version_underscore.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.version**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/00_1empty_variable.md b/tests/results/test_namespace_examples/00_1empty_variable.md new file mode 100644 index 0000000..e2af9f9 --- /dev/null +++ b/tests/results/test_namespace_examples/00_1empty_variable.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.empty**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/00_2default_calculated.md similarity index 96% rename from tests/docs/base/00_2default_calculated.md rename to tests/results/test_namespace_examples/00_2default_calculated.md index c73b8d8..5037eaa 100644 --- a/tests/docs/base/00_2default_calculated.md +++ b/tests/results/test_namespace_examples/00_2default_calculated.md @@ -2,20 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - multi: true - default: - jinja: | - {{ _.var1 }} - description: the value of var1 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -23,3 +9,12 @@ var2: | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: + - no +``` diff --git a/tests/docs/base/00_2default_calculated_multi.md b/tests/results/test_namespace_examples/00_2default_calculated_multi.md similarity index 95% rename from tests/docs/base/00_2default_calculated_multi.md rename to tests/results/test_namespace_examples/00_2default_calculated_multi.md index 03b0a23..473ac58 100644 --- a/tests/docs/base/00_2default_calculated_multi.md +++ b/tests/results/test_namespace_examples/00_2default_calculated_multi.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: # a first variable - - no - - yes - - maybe -var2: - description: a second variable - multi: true - default: - jinja: | - {% for val in _.var1 %} - {{ val }} - {% endfor %} - description: the value of _.var1 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -28,3 +9,17 @@ var2: | **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. | +# 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.md b/tests/results/test_namespace_examples/00_2default_calculated_variable_transitive.md similarity index 96% rename from tests/docs/base/00_2default_calculated_variable_transitive.md rename to tests/results/test_namespace_examples/00_2default_calculated_variable_transitive.md index 73d4bd5..e275a09 100644 --- a/tests/docs/base/00_2default_calculated_variable_transitive.md +++ b/tests/results/test_namespace_examples/00_2default_calculated_variable_transitive.md @@ -2,25 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                           | Description                                                                                                                        | @@ -28,3 +9,21 @@ var2: | **rougail.var1**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A first variable.
**Validator**: the domain name can be an IP | | **rougail.var2**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: the domain name can be an IP
**Default**: the value of the variable "rougail.var1". | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: + - example.net +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - example.net + var2: + - example.net +``` diff --git a/tests/docs/base/00_4load_subfolder.md b/tests/results/test_namespace_examples/00_4load_subfolder.md similarity index 96% rename from tests/docs/base/00_4load_subfolder.md rename to tests/results/test_namespace_examples/00_4load_subfolder.md index 852ef2b..8a7a96e 100644 --- a/tests/docs/base/00_4load_subfolder.md +++ b/tests/results/test_namespace_examples/00_4load_subfolder.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/99-base.yml - -```yaml ---- -version: '1.0' -var1: - description: a variable -``` -# dictionaries/rougail2/00-base.yml - -```yaml ---- -version: '1.0' -var2: - description: a variable -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | @@ -25,3 +9,19 @@ var2: | **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. | +# 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.md b/tests/results/test_namespace_examples/00_5load_notype.md similarity index 97% rename from tests/docs/base/00_5load_notype.md rename to tests/results/test_namespace_examples/00_5load_notype.md index 316bb29..a9760e9 100644 --- a/tests/docs/base/00_5load_notype.md +++ b/tests/results/test_namespace_examples/00_5load_notype.md @@ -2,18 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -without_type: - description: a variable - default: non -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.without_type**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: non | +# Example with all variables modifiable + +```yaml +--- +rougail: + without_type: non +``` diff --git a/tests/docs/base/00_6boolean.md b/tests/results/test_namespace_examples/00_6boolean.md similarity index 96% rename from tests/docs/base/00_6boolean.md rename to tests/results/test_namespace_examples/00_6boolean.md index 3ea429a..b92f3f0 100644 --- a/tests/docs/base/00_6boolean.md +++ b/tests/results/test_namespace_examples/00_6boolean.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: true # the first variable -var2: - description: the second variable - default: true -var3: - description: the third variable - type: boolean - default: true -var4: false # the forth variable -var5: - description: the fifth variable - default: false -var6: - description: the sixth variable - type: boolean - default: false -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -35,3 +13,15 @@ var6: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_6boolean_no_mandatory.md similarity index 96% rename from tests/docs/base/00_6boolean_no_mandatory.md rename to tests/results/test_namespace_examples/00_6boolean_no_mandatory.md index de6bdf4..dd57f5c 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.md +++ b/tests/results/test_namespace_examples/00_6boolean_no_mandatory.md @@ -2,19 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - type: boolean - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**: true | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: true +``` diff --git a/tests/docs/base/00_6choice.md b/tests/results/test_namespace_examples/00_6choice.md similarity index 94% rename from tests/docs/base/00_6choice.md rename to tests/results/test_namespace_examples/00_6choice.md index 5f8400c..87c84de 100644 --- a/tests/docs/base/00_6choice.md +++ b/tests/results/test_namespace_examples/00_6choice.md @@ -2,52 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: the first variable - choices: - - a - - b - - c -var2: - description: the second variable - choices: - - a - - b - - c -var3: - description: the third variable - choices: - - a - - b - - c - mandatory: false -var4: - description: the forth variable - choices: - - - - b - - c - mandatory: false -var5: - description: the fifth variable - choices: - - a - - b - - c - default: a -var6: - description: the sixth variable - choices: - - 1 - - 2 - - 3 - default: 1 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -59,3 +13,23 @@ var6: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_6choice_calculation.md similarity index 93% rename from tests/docs/base/00_6choice_calculation.md rename to tests/results/test_namespace_examples/00_6choice_calculation.md index 50cd345..639f804 100644 --- a/tests/docs/base/00_6choice_calculation.md +++ b/tests/results/test_namespace_examples/00_6choice_calculation.md @@ -2,25 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: - description: a variable - default: 9 - choices: - jinja: | - {% for n in trange(0, 10) %} - {{ n }} - {% endfor %} - return_type: number - description: choices is 0 to 9 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choices is 0 to 9.
**Default**: 9 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/base/00_6choice_variable.md b/tests/results/test_namespace_examples/00_6choice_variable.md similarity index 97% rename from tests/docs/base/00_6choice_variable.md rename to tests/results/test_namespace_examples/00_6choice_variable.md index 3db36d4..556fdee 100644 --- a/tests/docs/base/00_6choice_variable.md +++ b/tests/results/test_namespace_examples/00_6choice_variable.md @@ -2,21 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a second variable - - a - - b - - c -var2: - description: a first variable - default: a - choices: - variable: _.var1 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -24,3 +9,14 @@ var2: | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - a + - b + - c + var2: a +``` diff --git a/tests/docs/base/00_6custom.md b/tests/results/test_namespace_examples/00_6custom.md similarity index 96% rename from tests/docs/base/00_6custom.md rename to tests/results/test_namespace_examples/00_6custom.md index f01da56..d65c095 100644 --- a/tests/docs/base/00_6custom.md +++ b/tests/results/test_namespace_examples/00_6custom.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -custom1: - description: the first variable - type: custom -custom2: - description: the seconf variable - type: custom - default: value -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -22,3 +9,18 @@ custom2: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_6domainname.md similarity index 96% rename from tests/docs/base/00_6domainname.md rename to tests/results/test_namespace_examples/00_6domainname.md index 1548eef..65e45d9 100644 --- a/tests/docs/base/00_6domainname.md +++ b/tests/results/test_namespace_examples/00_6domainname.md @@ -2,19 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name -``` # Variables for "Rougail" | Variable                                                                                                       | Description                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A domain name variable.
**Default**: 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/results/test_namespace_examples/00_6domainname_params.md similarity index 95% rename from tests/docs/base/00_6domainname_params.md rename to tests/results/test_namespace_examples/00_6domainname_params.md index 0810f9d..7a9167a 100644 --- a/tests/docs/base/00_6domainname_params.md +++ b/tests/results/test_namespace_examples/00_6domainname_params.md @@ -2,21 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a domain name variable - type: domainname - default: my.domain.name - params: - allow_ip: true -``` # Variables for "Rougail" | Variable                                                                                                       | Description                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`domainname`](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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: my.domain.name +``` diff --git a/tests/docs/base/00_6float.md b/tests/results/test_namespace_examples/00_6float.md similarity index 96% rename from tests/docs/base/00_6float.md rename to tests/results/test_namespace_examples/00_6float.md index 40f6cfd..4bc2dea 100644 --- a/tests/docs/base/00_6float.md +++ b/tests/results/test_namespace_examples/00_6float.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: 0.0 # the first variable -var2: - description: the second variable - default: 0.0 -var3: - description: the third variable - type: float - default: 0.0 -var4: 10.1 # the forth variable -var5: - description: the fifth variable - default: 10.1 -var6: - description: the sixth variable - type: float - default: 10.1 -``` # Variables for "Rougail" | Variable                                                                                                  | Description                                                                                               | @@ -35,3 +13,15 @@ var6: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_6number.md similarity index 96% rename from tests/docs/base/00_6number.md rename to tests/results/test_namespace_examples/00_6number.md index fcb7e20..8d63015 100644 --- a/tests/docs/base/00_6number.md +++ b/tests/results/test_namespace_examples/00_6number.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: 0 # the first variable -var2: - description: the second variable - default: 0 -var3: - description: the third variable - type: number - default: 0 -var4: 10 # this forth variable -var5: - description: the fifth variable - default: 10 -var6: - description: the sixth variable - type: number - default: 10 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -35,3 +13,15 @@ var6: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_6port.md similarity index 95% rename from tests/docs/base/00_6port.md rename to tests/results/test_namespace_examples/00_6port.md index 634bfce..2d700ba 100644 --- a/tests/docs/base/00_6port.md +++ b/tests/results/test_namespace_examples/00_6port.md @@ -2,23 +2,6 @@ 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 for "Rougail" | Variable                                                                                                 | Description                                                                                              | @@ -27,3 +10,19 @@ variable3: | **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Default**: 8080 | | **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Default**: 8080 | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + variable1: '111' +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + variable1: '111' + variable2: '8080' + variable3: '8080' +``` diff --git a/tests/docs/base/00_6regexp.md b/tests/results/test_namespace_examples/00_6regexp.md similarity index 95% rename from tests/docs/base/00_6regexp.md rename to tests/results/test_namespace_examples/00_6regexp.md index f1afb7a..c472f40 100644 --- a/tests/docs/base/00_6regexp.md +++ b/tests/results/test_namespace_examples/00_6regexp.md @@ -2,22 +2,16 @@ 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 for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: #a1a1a1
**Examples**:
- #b1b1b1
- #b2b2b2 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: '#b1b1b1' +``` diff --git a/tests/docs/base/00_6string.md b/tests/results/test_namespace_examples/00_6string.md similarity index 96% rename from tests/docs/base/00_6string.md rename to tests/results/test_namespace_examples/00_6string.md index 5645749..23bf841 100644 --- a/tests/docs/base/00_6string.md +++ b/tests/results/test_namespace_examples/00_6string.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable -var2: - description: the second variable - default: -var3: - description: the third variable - type: string -var4: value # the forth variable -var5: - description: the fifth variable - default: value -var6: - description: the sixth variable - type: string - default: value -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -34,3 +13,24 @@ var6: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_7choice_quote.md similarity index 95% rename from tests/docs/base/00_7choice_quote.md rename to tests/results/test_namespace_examples/00_7choice_quote.md index 514ba79..bb73f8f 100644 --- a/tests/docs/base/00_7choice_quote.md +++ b/tests/results/test_namespace_examples/00_7choice_quote.md @@ -2,23 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - type: choice - description: A choice - default: quote' - choices: - - quote' - - quote" - - quote"' -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- quote' ← (default)
- quote"
- quote"' | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: quote' +``` diff --git a/tests/docs/base/00_7help_quote.md b/tests/results/test_namespace_examples/00_7help_quote.md similarity index 96% rename from tests/docs/base/00_7help_quote.md rename to tests/results/test_namespace_examples/00_7help_quote.md index 41c3ab8..fe5c3ec 100644 --- a/tests/docs/base/00_7help_quote.md +++ b/tests/results/test_namespace_examples/00_7help_quote.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var1: - description: the first variable - help: message with ' -var2: - description: the second variable - help: message with " -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | @@ -21,3 +9,19 @@ var2: | **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 ". | +# 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.md b/tests/results/test_namespace_examples/00_7value_doublequote.md similarity index 97% rename from tests/docs/base/00_7value_doublequote.md rename to tests/results/test_namespace_examples/00_7value_doublequote.md index 1424ea4..e70a653 100644 --- a/tests/docs/base/00_7value_doublequote.md +++ b/tests/results/test_namespace_examples/00_7value_doublequote.md @@ -2,18 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: quote" -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote" | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote" +``` diff --git a/tests/docs/base/00_7value_doublequote2.md b/tests/results/test_namespace_examples/00_7value_doublequote2.md similarity index 97% rename from tests/docs/base/00_7value_doublequote2.md rename to tests/results/test_namespace_examples/00_7value_doublequote2.md index 92d83dd..8dd2fc7 100644 --- a/tests/docs/base/00_7value_doublequote2.md +++ b/tests/results/test_namespace_examples/00_7value_doublequote2.md @@ -2,18 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: quote'" -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote'" | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote'" +``` diff --git a/tests/docs/base/00_7value_doublequote3.md b/tests/results/test_namespace_examples/00_7value_doublequote3.md similarity index 97% rename from tests/docs/base/00_7value_doublequote3.md rename to tests/results/test_namespace_examples/00_7value_doublequote3.md index 29b2738..e152d6d 100644 --- a/tests/docs/base/00_7value_doublequote3.md +++ b/tests/results/test_namespace_examples/00_7value_doublequote3.md @@ -2,19 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -variable: - description: a variable - default: quote\"\' -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote\"\' | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote\"\' +``` diff --git a/tests/docs/base/00_7value_quote.md b/tests/results/test_namespace_examples/00_7value_quote.md similarity index 97% rename from tests/docs/base/00_7value_quote.md rename to tests/results/test_namespace_examples/00_7value_quote.md index 2ee6b16..c6684d1 100644 --- a/tests/docs/base/00_7value_quote.md +++ b/tests/results/test_namespace_examples/00_7value_quote.md @@ -2,18 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -variable: - description: a variable - default: quote' -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: quote' | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: quote' +``` diff --git a/tests/results/test_namespace_examples/00_8calculation_information.md b/tests/results/test_namespace_examples/00_8calculation_information.md new file mode 100644 index 0000000..193fb85 --- /dev/null +++ b/tests/results/test_namespace_examples/00_8calculation_information.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: example +``` diff --git a/tests/docs/base/00_8test.md b/tests/results/test_namespace_examples/00_8test.md similarity index 95% rename from tests/docs/base/00_8test.md rename to tests/results/test_namespace_examples/00_8test.md index 469f532..6297759 100644 --- a/tests/docs/base/00_8test.md +++ b/tests/results/test_namespace_examples/00_8test.md @@ -2,50 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var1: - description: the first variable - test: - - test - -var2: - description: the second variable - test: - - test - default: value - -var3: - description: the third variable - test: - - test1 - - test2 - -var4: - description: the forth variable - test: - - - - test1 - - test2 - mandatory: false - -var5: - description: the fifth variable - type: boolean - test: - - false - -var6: - description: the sixth variable - multi: true - test: - - test1 - - test2 -``` # Variables for "Rougail" | Variable                                                                                                                    | Description                                                                                                                 | @@ -57,3 +13,28 @@ var6: | **rougail.var5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The fifth variable.
**Default**: true
**Example**: false | | **rougail.var6**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | The sixth variable.
**Examples**:
- test1
- test2 | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: test + var3: test1 + var6: + - test1 + - test2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test + var2: test + var3: test1 + var4: + var5: false + var6: + - test1 + - test2 +``` diff --git a/tests/docs/base/00_9choice_variable_multi.md b/tests/results/test_namespace_examples/00_9choice_variable_multi.md similarity index 95% rename from tests/docs/base/00_9choice_variable_multi.md rename to tests/results/test_namespace_examples/00_9choice_variable_multi.md index 72b5bdb..36b67c6 100644 --- a/tests/docs/base/00_9choice_variable_multi.md +++ b/tests/results/test_namespace_examples/00_9choice_variable_multi.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a first variable - type: choice - multi: true - choices: - - val1 - - val2 -variable2: - description: a second variable - type: choice - multi: true - mandatory: false - choices: - - val1 - - val2 -``` # Variables for "Rougail" | Variable                                                                                                                    | Description                                                                                                                 | @@ -30,3 +9,21 @@ variable2: | **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 | +# 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.md b/tests/results/test_namespace_examples/00_9choice_variables.md similarity index 95% rename from tests/docs/base/00_9choice_variables.md rename to tests/results/test_namespace_examples/00_9choice_variables.md index 7e3e09c..63b87e3 100644 --- a/tests/docs/base/00_9choice_variables.md +++ b/tests/results/test_namespace_examples/00_9choice_variables.md @@ -2,21 +2,6 @@ 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 for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -25,3 +10,12 @@ my_variable: | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + source_variable_1: val1 + source_variable_2: val2 + my_variable: val1 +``` diff --git a/tests/results/test_namespace_examples/00_9default_calculation.md b/tests/results/test_namespace_examples/00_9default_calculation.md new file mode 100644 index 0000000..150869e --- /dev/null +++ b/tests/results/test_namespace_examples/00_9default_calculation.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: 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.md b/tests/results/test_namespace_examples/00_9default_calculation_information.md similarity index 92% rename from tests/docs/base/00_9default_calculation_information.md rename to tests/results/test_namespace_examples/00_9default_calculation_information.md index 75109ca..1a117e5 100644 --- a/tests/docs/base/00_9default_calculation_information.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_information.md @@ -2,25 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a variable - default: - jinja: '{{ information }}' - params: - information: - type: information - information: test_information - variable: _.var - description: returns the information -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns the information. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: example +``` diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.md b/tests/results/test_namespace_examples/00_9default_calculation_information_other_variable.md similarity index 94% rename from tests/docs/base/00_9default_calculation_information_other_variable.md rename to tests/results/test_namespace_examples/00_9default_calculation_information_other_variable.md index d657fea..55298cd 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_information_other_variable.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - jinja: | - {{ information }} - params: - information: - type: information - information: test_information - variable: _.var1 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -26,3 +9,18 @@ var2: | **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**: depends on a calculation. | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_9default_calculation_multi_optional.md b/tests/results/test_namespace_examples/00_9default_calculation_multi_optional.md similarity index 96% rename from tests/docs/base/00_9default_calculation_multi_optional.md rename to tests/results/test_namespace_examples/00_9default_calculation_multi_optional.md index 575bf70..98ff9fd 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_multi_optional.md @@ -2,21 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -24,3 +9,12 @@ my_calculated_variable: | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | | **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: val1 + my_calculated_variable: + - val1 +``` diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.md b/tests/results/test_namespace_examples/00_9default_calculation_multi_optional2.md similarity index 96% rename from tests/docs/base/00_9default_calculation_multi_optional2.md rename to tests/results/test_namespace_examples/00_9default_calculation_multi_optional2.md index 285b4ae..98ff9fd 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional2.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_multi_optional2.md @@ -2,21 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -24,3 +9,12 @@ my_calculated_variable: | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | My_variable.
**Default**: val1 | | **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: val1 + my_calculated_variable: + - val1 +``` diff --git a/tests/results/test_namespace_examples/00_9default_calculation_optional.md b/tests/results/test_namespace_examples/00_9default_calculation_optional.md new file mode 100644 index 0000000..b396cf5 --- /dev/null +++ b/tests/results/test_namespace_examples/00_9default_calculation_optional.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + my_calculated_variable: + - example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + my_calculated_variable: + - example +``` diff --git a/tests/docs/base/00_9default_calculation_optional_exists.md b/tests/results/test_namespace_examples/00_9default_calculation_optional_exists.md similarity index 96% rename from tests/docs/base/00_9default_calculation_optional_exists.md rename to tests/results/test_namespace_examples/00_9default_calculation_optional_exists.md index 1a2acdb..1fdbc9d 100644 --- a/tests/docs/base/00_9default_calculation_optional_exists.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_optional_exists.md @@ -2,22 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -25,3 +9,15 @@ my_calculated_variable: | **rougail.my_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_variable.
**Default**:
- val1
- val2 | | **rougail.my_calculated_variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | My_calculated_variable.
**Default**: the value of the variable "rougail.my_variable". | +# Example with all variables modifiable + +```yaml +--- +rougail: + my_variable: + - val1 + - val2 + my_calculated_variable: + - val1 + - val2 +``` diff --git a/tests/docs/base/00_9default_calculation_param_optional.md b/tests/results/test_namespace_examples/00_9default_calculation_param_optional.md similarity index 89% rename from tests/docs/base/00_9default_calculation_param_optional.md rename to tests/results/test_namespace_examples/00_9default_calculation_param_optional.md index 2ccc244..3bc191e 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.md +++ b/tests/results/test_namespace_examples/00_9default_calculation_param_optional.md @@ -2,30 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - default: - jinja: '{% if var2 is defined %} {{ var2 }} {% elif var3 is defined %} {{ var3 - }} {% elif var4 is defined %} {{ var4 }} {% else %} {{ _.var2 }} {% endif %} ' - params: - var2: - variable: _.var2 - optional: true - var3: - variable: _.var3 - optional: true - var4: - variable: _.unknown_family.var - optional: true - description: returns a value - mandatory: false -var2: no # a second variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -33,3 +9,11 @@ var2: no # a second variable | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/base/00_9default_information_other_variable.md b/tests/results/test_namespace_examples/00_9default_information_other_variable.md similarity index 95% rename from tests/docs/base/00_9default_information_other_variable.md rename to tests/results/test_namespace_examples/00_9default_information_other_variable.md index 68cca3f..59cda84 100644 --- a/tests/docs/base/00_9default_information_other_variable.md +++ b/tests/results/test_namespace_examples/00_9default_information_other_variable.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a first variable -var2: - description: a second variable - default: - type: information - information: test_information - variable: _.var1 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -22,3 +9,18 @@ var2: | **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**: the value of the information "test_information" of the variable "rougail.var1". | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: example + var2: example +``` diff --git a/tests/docs/base/00_9default_integer.md b/tests/results/test_namespace_examples/00_9default_integer.md similarity index 93% rename from tests/docs/base/00_9default_integer.md rename to tests/results/test_namespace_examples/00_9default_integer.md index 307b0b9..547729d 100644 --- a/tests/docs/base/00_9default_integer.md +++ b/tests/results/test_namespace_examples/00_9default_integer.md @@ -2,25 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a variable - default: 9 - choices: - jinja: | - {% for item in trange(0, 10) %} - {{ item }} - {%- endfor %} - return_type: number - description: choice for 0 to 9 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Choices**: choice for 0 to 9.
**Default**: 9 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: 9 +``` diff --git a/tests/docs/base/00_9extra.md b/tests/results/test_namespace_examples/00_9extra.md similarity index 96% rename from tests/docs/base/00_9extra.md rename to tests/results/test_namespace_examples/00_9extra.md index ff34512..41b5b6e 100644 --- a/tests/docs/base/00_9extra.md +++ b/tests/results/test_namespace_examples/00_9extra.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: rougail # a variable -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: no - description: return no -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -32,3 +14,12 @@ variable: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **extra.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: return no. | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: rougail +extra: + variable: no +``` diff --git a/tests/docs/base/00_9extra_calculation.md b/tests/results/test_namespace_examples/00_9extra_calculation.md similarity index 94% rename from tests/docs/base/00_9extra_calculation.md rename to tests/results/test_namespace_examples/00_9extra_calculation.md index f6905a6..2a0bcca 100644 --- a/tests/docs/base/00_9extra_calculation.md +++ b/tests/results/test_namespace_examples/00_9extra_calculation.md @@ -2,38 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: value # a variable -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a first variable - default: - variable: rougail.variable -variable2: - description: a second variable - default: - jinja: | - {{ rougail.variable }} - description: copy the value of rougail.variable -variable3: - description: a third variable - default: - jinja: | - {{ variable }} - params: - variable: - variable: rougail.variable - description: copy the value of rougail.variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -48,3 +16,14 @@ variable3: | **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. | +# 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.md b/tests/results/test_namespace_examples/01_6boolean_multi.md similarity index 96% rename from tests/docs/base/01_6boolean_multi.md rename to tests/results/test_namespace_examples/01_6boolean_multi.md index a9acd15..32fcad0 100644 --- a/tests/docs/base/01_6boolean_multi.md +++ b/tests/results/test_namespace_examples/01_6boolean_multi.md @@ -2,46 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - true -var2: - description: the second variable - default: - - true -var3: - description: the third variable - type: boolean - default: - - true -var4: # the forth variable - - false -var5: - description: the fifth variable - default: - - false -var6: - description: the sixth variable - type: boolean - default: - - false - -var7: - description: the seventh variable - multi: true - default: - - true -var8: - description: the eighth variable - type: boolean - multi: true - default: - - true -``` # Variables for "Rougail" | Variable                                                                                                                        | Description                                                                                                                     | @@ -55,3 +15,25 @@ var8: | **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 | +# 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.md b/tests/results/test_namespace_examples/01_6custom_multi.md similarity index 96% rename from tests/docs/base/01_6custom_multi.md rename to tests/results/test_namespace_examples/01_6custom_multi.md index d73c197..12f7acb 100644 --- a/tests/docs/base/01_6custom_multi.md +++ b/tests/results/test_namespace_examples/01_6custom_multi.md @@ -2,21 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -custom1: - description: a first custom variable - type: custom - multi: true -custom2: - description: a second custom variable - type: custom - default: - - value -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -24,3 +9,21 @@ custom2: | **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 | +# 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.md b/tests/results/test_namespace_examples/01_6float_multi.md similarity index 96% rename from tests/docs/base/01_6float_multi.md rename to tests/results/test_namespace_examples/01_6float_multi.md index dbd356f..6665a2e 100644 --- a/tests/docs/base/01_6float_multi.md +++ b/tests/results/test_namespace_examples/01_6float_multi.md @@ -2,46 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - 0.0 -var2: - description: the second variable - default: - - 0.0 -var3: - description: the third variable - type: float - default: - - 0.0 -var4: # the forth variable - - 10.1 -var5: - description: the fifth variable - default: - - 10.1 -var6: - description: the sixth variable - type: float - default: - - 10.1 - -var7: - description: the seventh variable - multi: true - default: - - 0.0 -var8: - description: the eighth variable - type: float - multi: true - default: - - 0.0 -``` # Variables for "Rougail" | Variable                                                                                                                      | Description                                                                                                                   | @@ -55,3 +15,25 @@ var8: | **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 | +# 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.md b/tests/results/test_namespace_examples/01_6number_multi.md similarity index 96% rename from tests/docs/base/01_6number_multi.md rename to tests/results/test_namespace_examples/01_6number_multi.md index 87a93c9..03d1f9f 100644 --- a/tests/docs/base/01_6number_multi.md +++ b/tests/results/test_namespace_examples/01_6number_multi.md @@ -2,46 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # the first variable - - 0 -var2: - description: the second variable - default: - - 0 -var3: - description: the third variable - type: number - default: - - 0 -var4: # the forth variable - - 10 -var5: - description: the fifth variable - default: - - 10 -var6: - description: the sixth variable - type: number - default: - - 10 - -var7: - description: the seventh variable - multi: true - default: - - 0 -var8: - description: the eighth variable - type: number - multi: true - default: - - 0 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -55,3 +15,25 @@ var8: | **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 | +# 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.md b/tests/results/test_namespace_examples/01_6string_empty.md similarity index 97% rename from tests/docs/base/01_6string_empty.md rename to tests/results/test_namespace_examples/01_6string_empty.md index 18f3dac..dbc058c 100644 --- a/tests/docs/base/01_6string_empty.md +++ b/tests/results/test_namespace_examples/01_6string_empty.md @@ -2,21 +2,18 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: the second variable - empty: false - default: - - value - - -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | The second variable.
**Default**:
- value
- null | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - value + - +``` diff --git a/tests/docs/base/01_6string_multi.md b/tests/results/test_namespace_examples/01_6string_multi.md similarity index 96% rename from tests/docs/base/01_6string_multi.md rename to tests/results/test_namespace_examples/01_6string_multi.md index c7135e0..c1b098a 100644 --- a/tests/docs/base/01_6string_multi.md +++ b/tests/results/test_namespace_examples/01_6string_multi.md @@ -2,42 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: [] # the first variable -var2: - description: the second variable - default: [] -var3: - description: the third variable - type: string -var4: # the forth variable - - value -var5: - description: the fifth variable - default: - - value -var6: - description: the sixth variable - type: string - default: - - value - -var7: - description: the seventh variable - multi: true - default: - - value -var8: - description: the eighth variable - type: string - multi: true - default: - - value -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -51,3 +15,35 @@ var8: | **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 | +# 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.md b/tests/results/test_namespace_examples/01_7value_multi_doublequote.md similarity index 97% rename from tests/docs/base/01_7value_multi_doublequote.md rename to tests/results/test_namespace_examples/01_7value_multi_doublequote.md index 8dd2601..5e00275 100644 --- a/tests/docs/base/01_7value_multi_doublequote.md +++ b/tests/results/test_namespace_examples/01_7value_multi_doublequote.md @@ -2,19 +2,17 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote" -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote" | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote" +``` diff --git a/tests/docs/base/01_7value_multi_doublequote2.md b/tests/results/test_namespace_examples/01_7value_multi_doublequote2.md similarity index 97% rename from tests/docs/base/01_7value_multi_doublequote2.md rename to tests/results/test_namespace_examples/01_7value_multi_doublequote2.md index 1e4ea68..17cc01c 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.md +++ b/tests/results/test_namespace_examples/01_7value_multi_doublequote2.md @@ -2,19 +2,17 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote'" -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote'" | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote'" +``` diff --git a/tests/docs/base/01_7value_multi_quote.md b/tests/results/test_namespace_examples/01_7value_multi_quote.md similarity index 97% rename from tests/docs/base/01_7value_multi_quote.md rename to tests/results/test_namespace_examples/01_7value_multi_quote.md index 27e6f8e..f8c3fbd 100644 --- a/tests/docs/base/01_7value_multi_quote.md +++ b/tests/results/test_namespace_examples/01_7value_multi_quote.md @@ -2,19 +2,17 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - - quote' -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: quote' | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - quote' +``` diff --git a/tests/results/test_namespace_examples/01_8calculation_information_multi.md b/tests/results/test_namespace_examples/01_8calculation_information_multi.md new file mode 100644 index 0000000..d0252aa --- /dev/null +++ b/tests/results/test_namespace_examples/01_8calculation_information_multi.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - example +``` diff --git a/tests/results/test_namespace_examples/01_9choice_variable_multi.md b/tests/results/test_namespace_examples/01_9choice_variable_multi.md new file mode 100644 index 0000000..d0b0053 --- /dev/null +++ b/tests/results/test_namespace_examples/01_9choice_variable_multi.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + +# 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.md b/tests/results/test_namespace_examples/04_0type_param.md similarity index 96% rename from tests/docs/base/04_0type_param.md rename to tests/results/test_namespace_examples/04_0type_param.md index 8e4d709..1193a33 100644 --- a/tests/docs/base/04_0type_param.md +++ b/tests/results/test_namespace_examples/04_0type_param.md @@ -2,21 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -int: - description: A limited number - default: 10 - params: - min_number: 0 - max_number: 100 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A limited number.
**Validators**:
- the minimum value is 0
- the maximum value is 100
**Default**: 10 | +# Example with all variables modifiable + +```yaml +--- +rougail: + int: 10 +``` diff --git a/tests/docs/base/04_1auto_save.md b/tests/results/test_namespace_examples/04_1auto_save.md similarity index 97% rename from tests/docs/base/04_1auto_save.md rename to tests/results/test_namespace_examples/04_1auto_save.md index ec85cf4..8bb1392 100644 --- a/tests/docs/base/04_1auto_save.md +++ b/tests/results/test_namespace_examples/04_1auto_save.md @@ -2,19 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -variable: - description: an auto save variable - auto_save: true - default: no -``` # Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | An auto save variable.
**Default**: no | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: no +``` diff --git a/tests/docs/base/04_1auto_save_and_calculated.md b/tests/results/test_namespace_examples/04_1auto_save_and_calculated.md similarity index 97% rename from tests/docs/base/04_1auto_save_and_calculated.md rename to tests/results/test_namespace_examples/04_1auto_save_and_calculated.md index 436a720..52c7eb2 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.md +++ b/tests/results/test_namespace_examples/04_1auto_save_and_calculated.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var1: no # a first variable -var2: - description: a second variable - auto_save: true - default: - variable: _.var1 -``` # Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | @@ -21,3 +9,11 @@ var2: | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no +``` diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.md b/tests/results/test_namespace_examples/04_1auto_save_and_calculated_hidden.md similarity index 94% rename from tests/docs/base/04_1auto_save_and_calculated_hidden.md rename to tests/results/test_namespace_examples/04_1auto_save_and_calculated_hidden.md index 0aa6e91..2059360 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.md +++ b/tests/results/test_namespace_examples/04_1auto_save_and_calculated_hidden.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - auto_save: true - hidden: - jinja: | - {% if _.var1 == "yes" %} - _.var1 is yes - {% endif %} - description: only if the variable var1 has value "yes" - default: - jinja: yes - description: the value is always yes -``` # Variables for "Rougail" | Variable                                                                                                                           | Description                                                                                                                        | @@ -28,3 +9,11 @@ var2: | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/results/test_namespace_examples/04_1auto_save_and_hidden.md b/tests/results/test_namespace_examples/04_1auto_save_and_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/04_1auto_save_and_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/04_1default_calculation_hidden.md b/tests/results/test_namespace_examples/04_1default_calculation_hidden.md similarity index 95% rename from tests/docs/base/04_1default_calculation_hidden.md rename to tests/results/test_namespace_examples/04_1default_calculation_hidden.md index 4509ff6..6b5b7df 100644 --- a/tests/docs/base/04_1default_calculation_hidden.md +++ b/tests/results/test_namespace_examples/04_1default_calculation_hidden.md @@ -2,30 +2,6 @@ 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 for "Rougail" | Variable                                                                                                             | Description                                                                                                          | @@ -34,3 +10,19 @@ var3: | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: value + var2: example + var3: value +``` diff --git a/tests/docs/base/04_1default_calculation_hidden_2.md b/tests/results/test_namespace_examples/04_1default_calculation_hidden_2.md similarity index 95% rename from tests/docs/base/04_1default_calculation_hidden_2.md rename to tests/results/test_namespace_examples/04_1default_calculation_hidden_2.md index 0ac0791..382e4bc 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.md +++ b/tests/results/test_namespace_examples/04_1default_calculation_hidden_2.md @@ -2,30 +2,6 @@ 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 for "Rougail" | Variable                                                                                                             | Description                                                                                                          | @@ -34,3 +10,19 @@ var3: | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: value + var2: example + var3: example +``` diff --git a/tests/docs/base/04_5disabled_calculation.md b/tests/results/test_namespace_examples/04_5disabled_calculation.md similarity index 93% rename from tests/docs/base/04_5disabled_calculation.md rename to tests/results/test_namespace_examples/04_5disabled_calculation.md index ce18e5b..19fb981 100644 --- a/tests/docs/base/04_5disabled_calculation.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation.md @@ -2,29 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a conditional variable -variable1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" -variable2: - description: a second variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is egal to "yes" -``` # Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | @@ -33,3 +10,20 @@ variable2: | **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". | +# 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.md b/tests/results/test_namespace_examples/04_5disabled_calculation_default.md similarity index 91% rename from tests/docs/base/04_5disabled_calculation_default.md rename to tests/results/test_namespace_examples/04_5disabled_calculation_default.md index 3beb0a4..58fe232 100644 --- a/tests/docs/base/04_5disabled_calculation_default.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_default.md @@ -2,40 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -condition: no # a condition - -var1: - description: a first variable - disabled: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition - -var2: - description: a second variable - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition -``` # Variables for "Rougail" | Variable                                                                                                                | Description                                                                                                             | @@ -44,3 +10,12 @@ var2: | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5disabled_calculation_optional.md b/tests/results/test_namespace_examples/04_5disabled_calculation_optional.md similarity index 88% rename from tests/docs/base/04_5disabled_calculation_optional.md rename to tests/results/test_namespace_examples/04_5disabled_calculation_optional.md index e35719b..9ab0afd 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_optional.md @@ -2,43 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if unknown is not defined %} - unknown is undefined - {% elif unknown == "no" %} - unknown is no - {% endif %} - params: - unknown: - variable: _.unknown - optional: true - description: calculation from an unknown variable - mandatory: false -var2: - description: a second variable - hidden: - jinja: | - {% if condition is not defined %} - condition is undefined - {% elif condition == "no" %} - condition is no - {% endif %} - params: - condition: - variable: _.condition - optional: true - description: calculation from an condition variable - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -47,3 +10,12 @@ var2: | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: example + var2: example +``` diff --git a/tests/results/test_namespace_examples/04_5disabled_calculation_variable.md b/tests/results/test_namespace_examples/04_5disabled_calculation_variable.md new file mode 100644 index 0000000..081bb2b --- /dev/null +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + +# 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/results/test_namespace_examples/04_5disabled_calculation_variable2.md b/tests/results/test_namespace_examples/04_5disabled_calculation_variable2.md new file mode 100644 index 0000000..28ef633 --- /dev/null +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable2.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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". | + +# 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.md b/tests/results/test_namespace_examples/04_5disabled_calculation_variable3.md similarity index 96% rename from tests/docs/base/04_5disabled_calculation_variable3.md rename to tests/results/test_namespace_examples/04_5disabled_calculation_variable3.md index f8a460a..9eb0fca 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable3.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when: yes -``` # Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | @@ -21,3 +9,18 @@ variable: | **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". | +# 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/results/test_namespace_examples/04_5disabled_calculation_variable4.md similarity index 96% rename from tests/docs/base/04_5disabled_calculation_variable4.md rename to tests/results/test_namespace_examples/04_5disabled_calculation_variable4.md index b967749..9198df8 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.md +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable4.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -variable: - description: a variable - disabled: - variable: _.condition - when_not: yes -``` # Variables for "Rougail" | Variable                                                                                                             | Description                                                                                                          | @@ -21,3 +9,18 @@ variable: | **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". | +# 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.md b/tests/results/test_namespace_examples/04_5hidden_calculation.md similarity index 93% rename from tests/docs/base/04_5hidden_calculation.md rename to tests/results/test_namespace_examples/04_5hidden_calculation.md index 8caf341..62f011d 100644 --- a/tests/docs/base/04_5hidden_calculation.md +++ b/tests/results/test_namespace_examples/04_5hidden_calculation.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the condition -var1: - description: a first variable - default: no - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -var2: - description: a second variable - default: no - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -``` # Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | @@ -35,3 +10,12 @@ var2: | **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. | +# 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/results/test_namespace_examples/04_5hidden_calculation2.md similarity index 91% rename from tests/docs/base/04_5hidden_calculation2.md rename to tests/results/test_namespace_examples/04_5hidden_calculation2.md index d7b2e72..ecbecae 100644 --- a/tests/docs/base/04_5hidden_calculation2.md +++ b/tests/results/test_namespace_examples/04_5hidden_calculation2.md @@ -2,37 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: the value of condition -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition != "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: the value of condition -``` # Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | @@ -41,3 +10,12 @@ var2: | **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. | +# 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/results/test_namespace_examples/04_5hidden_calculation_default_calculation.md similarity index 91% rename from tests/docs/base/04_5hidden_calculation_default_calculation.md rename to tests/results/test_namespace_examples/04_5hidden_calculation_default_calculation.md index af84484..d2558d8 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.md +++ b/tests/results/test_namespace_examples/04_5hidden_calculation_default_calculation.md @@ -2,37 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var1: - description: a first variable - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ _.condition }} - description: returns the condition value -var2: - description: a second variable - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - default: - jinja: | - {{ rougail.condition }} - description: returns the condition value -``` # Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | @@ -41,3 +10,12 @@ var2: | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var1: no + var2: no +``` diff --git a/tests/docs/base/04_5validators.md b/tests/results/test_namespace_examples/04_5validators.md similarity index 93% rename from tests/docs/base/04_5validators.md rename to tests/results/test_namespace_examples/04_5validators.md index bfa61f7..585519e 100644 --- a/tests/docs/base/04_5validators.md +++ b/tests/results/test_namespace_examples/04_5validators.md @@ -2,24 +2,23 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -int: - description: A number - type: number - validators: - - jinja: | - {% if _.int > 100 %} - value is too high - {% endif %} - description: the max value is 100 -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.int**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/04_5validators_differ.md similarity index 93% rename from tests/docs/base/04_5validators_differ.md rename to tests/results/test_namespace_examples/04_5validators_differ.md index 20c757c..a4b2ba1 100644 --- a/tests/docs/base/04_5validators_differ.md +++ b/tests/results/test_namespace_examples/04_5validators_differ.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a first variable - test: - - another_value - type: string - default: oui - validators: - - jinja: | - {% if _.var1 == _.var2 %} - var1 must be different than var2 - {% endif %} - description: var1 must be different than var2 -var2: no # A second variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -28,3 +9,11 @@ var2: no # A second variable | **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
**Example**: another_value | | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: no | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: another_value + var2: no +``` diff --git a/tests/docs/base/04_5validators_multi.md b/tests/results/test_namespace_examples/04_5validators_multi.md similarity index 93% rename from tests/docs/base/04_5validators_multi.md rename to tests/results/test_namespace_examples/04_5validators_multi.md index 9f142cb..d93b904 100644 --- a/tests/docs/base/04_5validators_multi.md +++ b/tests/results/test_namespace_examples/04_5validators_multi.md @@ -2,27 +2,18 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 10.
**Default**:
- no
- yes | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - no + - yes +``` diff --git a/tests/docs/base/04_5validators_multi2.md b/tests/results/test_namespace_examples/04_5validators_multi2.md similarity index 91% rename from tests/docs/base/04_5validators_multi2.md rename to tests/results/test_namespace_examples/04_5validators_multi2.md index 9d7f6bd..6f21e04 100644 --- a/tests/docs/base/04_5validators_multi2.md +++ b/tests/results/test_namespace_examples/04_5validators_multi2.md @@ -2,34 +2,18 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A second variable.
**Validator**: check length is less than 3.
**Default**:
- no
- yes
**Examples**:
- val1
- val2 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 +``` diff --git a/tests/docs/base/05_0multi_not_uniq.md b/tests/results/test_namespace_examples/05_0multi_not_uniq.md similarity index 97% rename from tests/docs/base/05_0multi_not_uniq.md rename to tests/results/test_namespace_examples/05_0multi_not_uniq.md index 13259e5..bceca9b 100644 --- a/tests/docs/base/05_0multi_not_uniq.md +++ b/tests/results/test_namespace_examples/05_0multi_not_uniq.md @@ -2,20 +2,17 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: a variable - unique: false - default: - - non -``` # Variables for "Rougail" | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A variable.
**Default**: non | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - non +``` diff --git a/tests/docs/base/05_0multi_uniq.md b/tests/results/test_namespace_examples/05_0multi_uniq.md similarity index 97% rename from tests/docs/base/05_0multi_uniq.md rename to tests/results/test_namespace_examples/05_0multi_uniq.md index d930b34..905d740 100644 --- a/tests/docs/base/05_0multi_uniq.md +++ b/tests/results/test_namespace_examples/05_0multi_uniq.md @@ -2,20 +2,17 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - unique: true - default: - - non -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/base/12_1auto_save_expert.md b/tests/results/test_namespace_examples/12_1auto_save_expert.md similarity index 97% rename from tests/docs/base/12_1auto_save_expert.md rename to tests/results/test_namespace_examples/12_1auto_save_expert.md index 3f43608..5d8e433 100644 --- a/tests/docs/base/12_1auto_save_expert.md +++ b/tests/results/test_namespace_examples/12_1auto_save_expert.md @@ -2,20 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: - description: a variable - auto_save: true - mode: advanced - default: no -``` # Variables for "Rougail" | Variable                                                                                                                   | Description                                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` `auto modified` | A variable.
**Default**: no | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: no +``` diff --git a/tests/docs/base/16_0redefine_description.md b/tests/results/test_namespace_examples/16_0redefine_description.md similarity index 94% rename from tests/docs/base/16_0redefine_description.md rename to tests/results/test_namespace_examples/16_0redefine_description.md index d9457ae..ad4648f 100644 --- a/tests/docs/base/16_0redefine_description.md +++ b/tests/results/test_namespace_examples/16_0redefine_description.md @@ -2,26 +2,23 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: Redefine description -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -var: - description: Redefined - redefine: true -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/16_2family_redefine_calculation.md similarity index 95% rename from tests/docs/base/16_2family_redefine_calculation.md rename to tests/results/test_namespace_examples/16_2family_redefine_calculation.md index e37c8b5..4b0ec1e 100644 --- a/tests/docs/base/16_2family_redefine_calculation.md +++ b/tests/results/test_namespace_examples/16_2family_redefine_calculation.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -family: - redefine: true - disabled: - jinja: | - true -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -family: - var1: -``` # Variables for "Rougail" ## rougail.family @@ -33,3 +14,19 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/16_2family_redefine_disabled.md b/tests/results/test_namespace_examples/16_2family_redefine_disabled.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/16_2family_redefine_disabled.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/16_5exists_nonexists.md b/tests/results/test_namespace_examples/16_5exists_nonexists.md similarity index 95% rename from tests/docs/base/16_5exists_nonexists.md rename to tests/results/test_namespace_examples/16_5exists_nonexists.md index 8758a82..f1f3d96 100644 --- a/tests/docs/base/16_5exists_nonexists.md +++ b/tests/results/test_namespace_examples/16_5exists_nonexists.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var2: - description: a new variable - exists: false - default: yes -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -26,3 +9,11 @@ var1: no # a variable | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: yes +``` diff --git a/tests/results/test_namespace_examples/16_5exists_redefine.md b/tests/results/test_namespace_examples/16_5exists_redefine.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/16_5exists_redefine.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/16_5redefine_calculation.md b/tests/results/test_namespace_examples/16_5redefine_calculation.md new file mode 100644 index 0000000..23d92aa --- /dev/null +++ b/tests/results/test_namespace_examples/16_5redefine_calculation.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: returns yes. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/base/16_5redefine_choice.md b/tests/results/test_namespace_examples/16_5redefine_choice.md similarity index 93% rename from tests/docs/base/16_5redefine_choice.md rename to tests/results/test_namespace_examples/16_5redefine_choice.md index f6eb1d3..06830e6 100644 --- a/tests/docs/base/16_5redefine_choice.md +++ b/tests/results/test_namespace_examples/16_5redefine_choice.md @@ -2,32 +2,23 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - choices: - - a - - b - - c -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.0' -variable: - redefine: true - choices: - - a - - b -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Choices**:
- 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.md b/tests/results/test_namespace_examples/16_5redefine_default.md similarity index 94% rename from tests/docs/base/16_5redefine_default.md rename to tests/results/test_namespace_examples/16_5redefine_default.md index e33ec23..35d948d 100644 --- a/tests/docs/base/16_5redefine_default.md +++ b/tests/results/test_namespace_examples/16_5redefine_default.md @@ -2,27 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: no -``` -# dictionaries/rougail/01-redefine.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: yes -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable.
**Default**: yes | +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: yes +``` diff --git a/tests/docs/base/16_5redefine_default_calculation.md b/tests/results/test_namespace_examples/16_5redefine_default_calculation.md similarity index 94% rename from tests/docs/base/16_5redefine_default_calculation.md rename to tests/results/test_namespace_examples/16_5redefine_default_calculation.md index 741b5af..6346c52 100644 --- a/tests/docs/base/16_5redefine_default_calculation.md +++ b/tests/results/test_namespace_examples/16_5redefine_default_calculation.md @@ -2,28 +2,23 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - default: -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable: - description: a variable - default: - jinja: yes -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/16_5redefine_family.md similarity index 94% rename from tests/docs/base/16_5redefine_family.md rename to tests/results/test_namespace_examples/16_5redefine_family.md index 9f48308..1a7d800 100644 --- a/tests/docs/base/16_5redefine_family.md +++ b/tests/results/test_namespace_examples/16_5redefine_family.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - description: new description -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - variable: # a variable -``` # Variables for "Rougail" ## new description @@ -29,3 +12,19 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/16_5redefine_help.md similarity index 91% rename from tests/docs/base/16_5redefine_help.md rename to tests/results/test_namespace_examples/16_5redefine_help.md index b6294ff..e44afc4 100644 --- a/tests/docs/base/16_5redefine_help.md +++ b/tests/results/test_namespace_examples/16_5redefine_help.md @@ -2,30 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - redefine: true - help: redefine help family ok - variable: - redefine: true - help: redefine help ok -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: a family - help: redefine help family - variable: - description: redefine help - help: redefine help -``` # Variables for "Rougail" ## a family @@ -38,3 +14,19 @@ Redefine help family ok. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/16_5redefine_hidden.md b/tests/results/test_namespace_examples/16_5redefine_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/16_5redefine_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/16_5redefine_multi.md b/tests/results/test_namespace_examples/16_5redefine_multi.md new file mode 100644 index 0000000..905d740 --- /dev/null +++ b/tests/results/test_namespace_examples/16_5redefine_multi.md @@ -0,0 +1,18 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: non | + +# Example with all variables modifiable + +```yaml +--- +rougail: + variable: + - non +``` diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.md b/tests/results/test_namespace_examples/16_5redefine_remove_disable_calculation.md similarity index 93% rename from tests/docs/base/16_5redefine_remove_disable_calculation.md rename to tests/results/test_namespace_examples/16_5redefine_remove_disable_calculation.md index 8c582f6..3030975 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.md +++ b/tests/results/test_namespace_examples/16_5redefine_remove_disable_calculation.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -variable: - redefine: true - disabled: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -variable: - description: a variable - disabled: - jinja: | - {% if _.condition == "yes" %} - true - {% else %} - false - {% endif %} -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -34,3 +9,18 @@ variable: | **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. | +# 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.md b/tests/results/test_namespace_examples/16_5test_redefine.md similarity index 94% rename from tests/docs/base/16_5test_redefine.md rename to tests/results/test_namespace_examples/16_5test_redefine.md index 38a137b..8f2e9d1 100644 --- a/tests/docs/base/16_5test_redefine.md +++ b/tests/results/test_namespace_examples/16_5test_redefine.md @@ -2,39 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: - description: a second variable - test: - - test - default: non -var3: - description: a third variable - test: - - test -``` -# dictionaries/rougail/10-base.yml - -```yaml ---- -version: '1.1' -var1: - redefine: true - test: - - test1 -var2: - redefine: true - test: - - test1 -var3: - redefine: true - test: -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -43,3 +10,19 @@ var3: | **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. | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var3: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: test1 + var2: test1 + var3: example +``` diff --git a/tests/docs/base/16_6choice_redefine.md b/tests/results/test_namespace_examples/16_6choice_redefine.md similarity index 93% rename from tests/docs/base/16_6choice_redefine.md rename to tests/results/test_namespace_examples/16_6choice_redefine.md index 964d2eb..7a363e0 100644 --- a/tests/docs/base/16_6choice_redefine.md +++ b/tests/results/test_namespace_examples/16_6choice_redefine.md @@ -2,34 +2,16 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.0' -var: - redefine: true - choices: - - a - - c -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - type: choice - description: A choice - default: c - choices: - - a - - b - - c -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A choice.
**Choices**:
- a
- c ← (default) | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: c +``` diff --git a/tests/results/test_namespace_examples/16_6exists_redefine_family.md b/tests/results/test_namespace_examples/16_6exists_redefine_family.md new file mode 100644 index 0000000..ee9fd4e --- /dev/null +++ b/tests/results/test_namespace_examples/16_6exists_redefine_family.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## new description + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family1.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +## a second family + +`basic` + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.family2.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family1: + variable1: example + family2: + variable2: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family1: + variable1: example + family2: + variable2: example +``` diff --git a/tests/docs/base/16exists_exists.md b/tests/results/test_namespace_examples/16exists_exists.md similarity index 95% rename from tests/docs/base/16exists_exists.md rename to tests/results/test_namespace_examples/16exists_exists.md index c33be25..4513679 100644 --- a/tests/docs/base/16exists_exists.md +++ b/tests/results/test_namespace_examples/16exists_exists.md @@ -2,26 +2,23 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var: - description: New description - exists: false -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: Description -``` # Variables for "Rougail" | Variable                                                                                                | Description                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/17_5redefine_leadership.md b/tests/results/test_namespace_examples/17_5redefine_leadership.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/17_5redefine_leadership.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/20_0empty_family.md b/tests/results/test_namespace_examples/20_0empty_family.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/20_0empty_family.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/20_0family_append.md b/tests/results/test_namespace_examples/20_0family_append.md similarity index 95% rename from tests/docs/base/20_0family_append.md rename to tests/results/test_namespace_examples/20_0family_append.md index 2d0e583..6d75af5 100644 --- a/tests/docs/base/20_0family_append.md +++ b/tests/results/test_namespace_examples/20_0family_append.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -family: - var2: - description: The second variable -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: A family - var1: - description: The first variable -``` # Variables for "Rougail" ## A family @@ -32,3 +13,21 @@ family: | **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. | +# 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/results/test_namespace_examples/20_0family_underscore.md b/tests/results/test_namespace_examples/20_0family_underscore.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/20_0family_underscore.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/20_0multi_family.md b/tests/results/test_namespace_examples/20_0multi_family.md similarity index 95% rename from tests/docs/base/20_0multi_family.md rename to tests/results/test_namespace_examples/20_0multi_family.md index ee63139..10c3305 100644 --- a/tests/docs/base/20_0multi_family.md +++ b/tests/results/test_namespace_examples/20_0multi_family.md @@ -2,17 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - subfamily: # a sub family - variable: - description: a variable - mandatory: false -``` # Variables for "Rougail" ## a family @@ -27,3 +16,12 @@ 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/results/test_namespace_examples/20_0multi_family_basic.md b/tests/results/test_namespace_examples/20_0multi_family_basic.md new file mode 100644 index 0000000..27996d3 --- /dev/null +++ b/tests/results/test_namespace_examples/20_0multi_family_basic.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a family + +`basic` + +### 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. | + +# 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_expert.md b/tests/results/test_namespace_examples/20_0multi_family_expert.md similarity index 94% rename from tests/docs/base/20_0multi_family_expert.md rename to tests/results/test_namespace_examples/20_0multi_family_expert.md index 9f0669d..0968d16 100644 --- a/tests/docs/base/20_0multi_family_expert.md +++ b/tests/results/test_namespace_examples/20_0multi_family_expert.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: - description: a family - mode: advanced - subfamily: # a sub family - variable: - description: a variable - mandatory: false -``` # Variables for "Rougail" ## a family @@ -29,3 +16,12 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.subfamily.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` | A variable. | +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + subfamily: + variable: example +``` diff --git a/tests/results/test_namespace_examples/20_0multi_family_order.md b/tests/results/test_namespace_examples/20_0multi_family_order.md new file mode 100644 index 0000000..91431e0 --- /dev/null +++ b/tests/results/test_namespace_examples/20_0multi_family_order.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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. | + +### 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.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/20_0validators_differ_redefine.md similarity index 90% rename from tests/docs/base/20_0validators_differ_redefine.md rename to tests/results/test_namespace_examples/20_0validators_differ_redefine.md index fc0784b..8b8c13d 100644 --- a/tests/docs/base/20_0validators_differ_redefine.md +++ b/tests/results/test_namespace_examples/20_0validators_differ_redefine.md @@ -2,39 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -var3: - redefine: true - validators: - - jinja: | - {% if _.var3 == _.var2 %} - var3 must be different than var2 - {% endif %} - description: var3 must be different than var2 -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: no # a first variable -var2: no # a second variable -var3: - description: a third variable - default: yes - test: - - yes - validators: - - jinja: | - {% if _.var3 == _.var1 %} - var3 must be different than var1 - {% endif %} - description: var3 must be different than var1 -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -43,3 +10,12 @@ 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.
**Validator**: var3 must be different than var2.
**Default**: yes
**Example**: yes | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: no + var2: no + var3: yes +``` diff --git a/tests/results/test_namespace_examples/20_1empty_subfamily.md b/tests/results/test_namespace_examples/20_1empty_subfamily.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/20_1empty_subfamily.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/20_9default_information_parent.md b/tests/results/test_namespace_examples/20_9default_information_parent.md similarity index 95% rename from tests/docs/base/20_9default_information_parent.md rename to tests/results/test_namespace_examples/20_9default_information_parent.md index 011e580..0fb4dab 100644 --- a/tests/docs/base/20_9default_information_parent.md +++ b/tests/results/test_namespace_examples/20_9default_information_parent.md @@ -2,20 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -family: - var1: # a first variable - var2: - description: a second variable - default: - type: information - information: test_information - variable: __.family -``` # Variables for "Rougail" ## rougail.family @@ -27,3 +13,20 @@ family: | **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**: the value of the information "test_information" of the variable "rougail.family". | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + family: + var1: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var1: example + var2: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition.md b/tests/results/test_namespace_examples/24_0family_hidden_condition.md similarity index 95% rename from tests/docs/base/24_0family_hidden_condition.md rename to tests/results/test_namespace_examples/24_0family_hidden_condition.md index cf670e8..302c635 100644 --- a/tests/docs/base/24_0family_hidden_condition.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_condition.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - var1: # a variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -34,3 +18,20 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/24_0family_hidden_condition_boolean.md similarity index 95% rename from tests/docs/base/24_0family_hidden_condition_boolean.md rename to tests/results/test_namespace_examples/24_0family_hidden_condition_boolean.md index 8778f8d..c3ed8de 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_condition_boolean.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: false # a conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition %} - condition is false - {% endif %} - description: if not condition - variable: - description: a variable - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -36,3 +18,12 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: false + family: + variable: example +``` diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.md b/tests/results/test_namespace_examples/24_0family_hidden_condition_sub_family.md similarity index 95% rename from tests/docs/base/24_0family_hidden_condition_sub_family.md rename to tests/results/test_namespace_examples/24_0family_hidden_condition_sub_family.md index d8b242e..3221c85 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_condition_sub_family.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes - subfamily: - var1: # a variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -39,3 +22,22 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/24_0family_hidden_condition_variable_sub_family.md similarity index 96% rename from tests/docs/base/24_0family_hidden_condition_variable_sub_family.md rename to tests/results/test_namespace_examples/24_0family_hidden_condition_variable_sub_family.md index 9f9423b..8e21a60 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_condition_variable_sub_family.md @@ -2,21 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # the variable use has condition -family: - description: possibly hidden family - hidden: - variable: _.condition - subfamily: # a subfamily - var1: - description: a variable - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -37,3 +22,13 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.subfamily.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable. | +# 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.md b/tests/results/test_namespace_examples/24_0family_hidden_condition_with_variable.md similarity index 94% rename from tests/docs/base/24_0family_hidden_condition_with_variable.md rename to tests/results/test_namespace_examples/24_0family_hidden_condition_with_variable.md index d7637c4..b034b67 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_condition_with_variable.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition1: false # a first conditional variable -condition2: false # a second conditional variable -family: - description: a family - hidden: - jinja: | - {% if not rougail.condition1 %} - condition1 is false - {% endif %} - description: if condition1 is false - variable: - description: a variable - hidden: - jinja: | - {% if rougail.condition2 %} - condition2 is true - {% endif %} - description: if condition2 is false - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -44,3 +19,13 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A variable.
**Hidden**: if condition2 is false. | +# 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.md b/tests/results/test_namespace_examples/24_0family_hidden_param_condition_sub_family.md similarity index 94% rename from tests/docs/base/24_0family_hidden_param_condition_sub_family.md rename to tests/results/test_namespace_examples/24_0family_hidden_param_condition_sub_family.md index 3c28773..2adbcfe 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md +++ b/tests/results/test_namespace_examples/24_0family_hidden_param_condition_sub_family.md @@ -2,26 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # the variable use has condition -family: - description: possibly hidden family - hidden: - jinja: | - {% if condition == "yes" %} - condition is yes - {% endif %} - params: - condition: - variable: _.condition - description: if condition is yes - sub_family: # a subfamily - var1: # a variable -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -42,3 +22,22 @@ family: |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.sub_family.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/24_0family_mandatory_condition.md similarity index 94% rename from tests/docs/base/24_0family_mandatory_condition.md rename to tests/results/test_namespace_examples/24_0family_mandatory_condition.md index 4c7b1e7..66fd251 100644 --- a/tests/docs/base/24_0family_mandatory_condition.md +++ b/tests/results/test_namespace_examples/24_0family_mandatory_condition.md @@ -2,21 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -var: - description: a variable - mandatory: - jinja: | - {% if _.condition == "yes" %} - condition is yes - {% endif %} - description: only if rougail.condition has the value "yes" -``` # Variables for "Rougail" | Variable                                                                                                     | Description                                                                                                  | @@ -24,3 +9,11 @@ var: | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: no + var: example +``` diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.md b/tests/results/test_namespace_examples/24_0family_mandatory_condition_variable.md similarity index 97% rename from tests/docs/base/24_0family_mandatory_condition_variable.md rename to tests/results/test_namespace_examples/24_0family_mandatory_condition_variable.md index d9f1598..b1be4a5 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.md +++ b/tests/results/test_namespace_examples/24_0family_mandatory_condition_variable.md @@ -2,17 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -var: - description: a variable - mandatory: - variable: _.condition -``` # Variables for "Rougail" | Variable                                                                                                     | Description                                                                                                  | @@ -20,3 +9,11 @@ var: | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + var: example +``` diff --git a/tests/docs/base/24_7validators_variable_optional.md b/tests/results/test_namespace_examples/24_7validators_variable_optional.md similarity index 87% rename from tests/docs/base/24_7validators_variable_optional.md rename to tests/results/test_namespace_examples/24_7validators_variable_optional.md index 799ff74..c1de350 100644 --- a/tests/docs/base/24_7validators_variable_optional.md +++ b/tests/results/test_namespace_examples/24_7validators_variable_optional.md @@ -2,38 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -general: # a family - int: - description: a first number - type: number - test: - - 5 - validators: - - jinja: | - {% if _.int == int2 %} - int and int2 must be different - {% endif %} - params: - int2: - variable: _.int2 - optional: true - description: int and int2 must be different - - jinja: | - {% if int3 is defined and _.int == int3 %} - int and int3 must be different - {% endif %} - params: - int3: - variable: _.int3 - optional: true - description: int and int3 must be different - int2: 1 # a second number -``` # Variables for "Rougail" ## a family @@ -45,3 +13,20 @@ general: # a family | **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.
**Example**: 5 | | **rougail.general.int2**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second number.
**Default**: 1 | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + general: + int: 5 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + int: 5 + int2: 1 +``` diff --git a/tests/results/test_namespace_examples/24_family_disabled_var_hidden.md b/tests/results/test_namespace_examples/24_family_disabled_var_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/24_family_disabled_var_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/40_0leadership.md b/tests/results/test_namespace_examples/40_0leadership.md similarity index 97% rename from tests/docs/base/40_0leadership.md rename to tests/results/test_namespace_examples/40_0leadership.md index fb9b865..29edbb7 100644 --- a/tests/docs/base/40_0leadership.md +++ b/tests/results/test_namespace_examples/40_0leadership.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: # a follower - follower2: # an other follower -``` # Variables for "Rougail" ## a leadership @@ -28,3 +16,13 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/base/40_0leadership_diff_name.md b/tests/results/test_namespace_examples/40_0leadership_diff_name.md similarity index 97% rename from tests/docs/base/40_0leadership_diff_name.md rename to tests/results/test_namespace_examples/40_0leadership_diff_name.md index 99e9a84..1ad873a 100644 --- a/tests/docs/base/40_0leadership_diff_name.md +++ b/tests/results/test_namespace_examples/40_0leadership_diff_name.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leadership: - description: a leadership - type: leadership - leader: [] # a leader - follower1: # a follower - follower2: # an other follower -``` # Variables for "Rougail" ## a leadership @@ -28,3 +16,13 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/results/test_namespace_examples/40_0leadership_empty.md b/tests/results/test_namespace_examples/40_0leadership_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/40_0leadership_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.md b/tests/results/test_namespace_examples/40_0leadership_follower_default_calculation.md similarity index 95% rename from tests/docs/base/40_0leadership_follower_default_calculation.md rename to tests/results/test_namespace_examples/40_0leadership_follower_default_calculation.md index 91bfc5c..57808ec 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.md +++ b/tests/results/test_namespace_examples/40_0leadership_follower_default_calculation.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - follower1: value # a follower - follower2: - description: a second follower - default: - jinja: | - {{ _.follower1 }} - description: returns follower1 value -``` # Variables for "Rougail" ## a leadership @@ -33,3 +16,13 @@ This family contains lists of variable blocks. | **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. | +# 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.md b/tests/results/test_namespace_examples/40_0leadership_follower_default_submulti.md similarity index 96% rename from tests/docs/base/40_0leadership_follower_default_submulti.md rename to tests/results/test_namespace_examples/40_0leadership_follower_default_submulti.md index d6ff220..95453a8 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.md +++ b/tests/results/test_namespace_examples/40_0leadership_follower_default_submulti.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - leader - follower1: # a follower1 - - value - follower2: # a follower2 - - value1 - - value2 -``` # Variables for "Rougail" ## a leadership @@ -32,3 +16,16 @@ This family contains lists of variable blocks. | **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 | +# 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.md b/tests/results/test_namespace_examples/40_0leadership_follower_default_submulti_calculation.md similarity index 96% rename from tests/docs/base/40_0leadership_follower_default_submulti_calculation.md rename to tests/results/test_namespace_examples/40_0leadership_follower_default_submulti_calculation.md index bef92c8..1b8c5ea 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.md +++ b/tests/results/test_namespace_examples/40_0leadership_follower_default_submulti_calculation.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # the leader - - leader - follower1: # the follower1 - - value - follower2: - description: the follower2 - multi: true - default: - variable: _.follower1 -``` # Variables for "Rougail" ## a leadership @@ -34,3 +16,15 @@ This family contains lists of variable blocks. | **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". | +# 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.md b/tests/results/test_namespace_examples/40_0leadership_follower_default_value.md similarity index 96% rename from tests/docs/base/40_0leadership_follower_default_value.md rename to tests/results/test_namespace_examples/40_0leadership_follower_default_value.md index fcd2592..ee5a801 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.md +++ b/tests/results/test_namespace_examples/40_0leadership_follower_default_value.md @@ -2,20 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower1: value # a follower with default value -``` # Variables for "Rougail" ## a leadership @@ -29,3 +15,12 @@ This family contains lists of variable blocks. | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: value +``` diff --git a/tests/docs/base/40_0leadership_leader_not_multi.md b/tests/results/test_namespace_examples/40_0leadership_leader_not_multi.md similarity index 96% rename from tests/docs/base/40_0leadership_leader_not_multi.md rename to tests/results/test_namespace_examples/40_0leadership_leader_not_multi.md index 038389e..519c093 100644 --- a/tests/docs/base/40_0leadership_leader_not_multi.md +++ b/tests/results/test_namespace_examples/40_0leadership_leader_not_multi.md @@ -2,30 +2,6 @@ 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 for "Rougail" ## rougail.general @@ -52,3 +28,16 @@ This family contains lists of variable blocks. | **rougail.general1.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower1. | | **rougail.general1.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Follower2. | +# Example with all variables modifiable + +```yaml +--- +rougail: + general: + mode_conteneur_actif: non + general1: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/docs/base/40_1leadership_append_follower.md b/tests/results/test_namespace_examples/40_1leadership_append_follower.md similarity index 95% rename from tests/docs/base/40_1leadership_append_follower.md rename to tests/results/test_namespace_examples/40_1leadership_append_follower.md index cf0b5ce..f827584 100644 --- a/tests/docs/base/40_1leadership_append_follower.md +++ b/tests/results/test_namespace_examples/40_1leadership_append_follower.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/01-base.yml - -```yaml ---- -version: '1.1' -leader: - follower3: - description: the follower3 -``` -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: the leader - multi: true - follower1: - description: the follower1 - follower2: - description: the follower2 -``` # Variables for "Rougail" ## a leadership @@ -42,3 +17,14 @@ This family contains lists of variable blocks. | **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. | +# 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.md b/tests/results/test_namespace_examples/40_2leadership_calculation_index.md similarity index 96% rename from tests/docs/base/40_2leadership_calculation_index.md rename to tests/results/test_namespace_examples/40_2leadership_calculation_index.md index 7da0257..ba63dd0 100644 --- a/tests/docs/base/40_2leadership_calculation_index.md +++ b/tests/results/test_namespace_examples/40_2leadership_calculation_index.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - type: index -``` # Variables for "Rougail" ## a leadership @@ -33,3 +15,16 @@ This family contains lists of variable blocks. | **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**: the value of the index. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 0 + - leader: b + follower1: 1 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/base/40_2leadership_calculation_param_index.md b/tests/results/test_namespace_examples/40_2leadership_calculation_param_index.md similarity index 94% rename from tests/docs/base/40_2leadership_calculation_param_index.md rename to tests/results/test_namespace_examples/40_2leadership_calculation_param_index.md index 146e7f8..c1bd33a 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.md +++ b/tests/results/test_namespace_examples/40_2leadership_calculation_param_index.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: leadership - type: leadership - leader: # a leader - - a - - b - - c - follower1: - description: a follower - type: number - default: - jinja: '{{ index }}' - params: - index: - type: index - description: returns index -``` # Variables for "Rougail" ## leadership @@ -37,3 +15,16 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower1: 0 + - leader: b + follower1: 1 + - leader: c + follower1: 2 +``` diff --git a/tests/docs/base/40_2leadership_leader_calculation.md b/tests/results/test_namespace_examples/40_2leadership_leader_calculation.md similarity index 95% rename from tests/docs/base/40_2leadership_leader_calculation.md rename to tests/results/test_namespace_examples/40_2leadership_leader_calculation.md index 81772ba..f5eca2e 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.md +++ b/tests/results/test_namespace_examples/40_2leadership_leader_calculation.md @@ -2,29 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -leader: - description: a leadership - type: leadership - - leader: - description: a leader - multi: true - default: - jinja: | - val1 - val2 - description: returns val1 and val2 - - follower1: # a first follower - - follower2: # a second follower -``` # Variables for "Rougail" ## a leadership @@ -39,3 +16,16 @@ This family contains lists of variable blocks. | **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. | +# 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.md b/tests/results/test_namespace_examples/40_6leadership_follower_multi.md similarity index 95% rename from tests/docs/base/40_6leadership_follower_multi.md rename to tests/results/test_namespace_examples/40_6leadership_follower_multi.md index baa4ca5..4b26182 100644 --- a/tests/docs/base/40_6leadership_follower_multi.md +++ b/tests/results/test_namespace_examples/40_6leadership_follower_multi.md @@ -2,26 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leadership: - description: A leadership - type: leadership - leader: - description: The leader - multi: true - follower1: - description: The first follower - multi: true - follower2: - description: The second follower - multi: true - default: - - value -``` # Variables for "Rougail" ## A leadership @@ -36,3 +16,15 @@ This family contains lists of variable blocks. | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + leadership: + - leader: example + follower1: + - example + follower2: + - value +``` diff --git a/tests/docs/base/40_8calculation_boolean.md b/tests/results/test_namespace_examples/40_8calculation_boolean.md similarity index 93% rename from tests/docs/base/40_8calculation_boolean.md rename to tests/results/test_namespace_examples/40_8calculation_boolean.md index a75febc..e39342a 100644 --- a/tests/docs/base/40_8calculation_boolean.md +++ b/tests/results/test_namespace_examples/40_8calculation_boolean.md @@ -2,39 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -bool: false # a boolean variable -multi1: - description: a first multi variable - type: boolean - multi: true - default: - jinja: | - {% if _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation -multi2: - description: a second multi variable - type: boolean - multi: true - default: - jinja: | - {% if not _.bool %} - True - False - {% else %} - False - {% endif %} - description: a calculation -``` # Variables for "Rougail" | Variable                                                                                                                        | Description                                                                                                                     | @@ -43,3 +10,15 @@ multi2: | **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. | +# 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.md b/tests/results/test_namespace_examples/40_8calculation_boolean_return_none.md similarity index 94% rename from tests/docs/base/40_8calculation_boolean_return_none.md rename to tests/results/test_namespace_examples/40_8calculation_boolean_return_none.md index e73d42c..100082f 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.md +++ b/tests/results/test_namespace_examples/40_8calculation_boolean_return_none.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: yes # a first variable -var2: - description: a second variable - type: boolean - default: - jinja: | - {% if rougail.var1 == 'no' %} - false - {% endif %} - description: return false if the value of var1 is "no" -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -25,3 +9,11 @@ var2: | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: yes + var2: xxx +``` diff --git a/tests/docs/base/40_8calculation_integer.md b/tests/results/test_namespace_examples/40_8calculation_integer.md similarity index 92% rename from tests/docs/base/40_8calculation_integer.md rename to tests/results/test_namespace_examples/40_8calculation_integer.md index 4df7086..1eec26a 100644 --- a/tests/docs/base/40_8calculation_integer.md +++ b/tests/results/test_namespace_examples/40_8calculation_integer.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -bool: false # a boolean variable -int1: - description: first integer variable - type: number - default: - jinja: | - {% if rougail.bool %}1{% else %}2{% endif %} - description: if bool returns 1 otherwise return 2 -int2: - description: second integer variable - type: number - default: - jinja: | - {% if not rougail.bool %}3{% else %}4{% endif %} - description: if bool returns 3 otherwise return 4 -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -31,3 +10,12 @@ int2: | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + bool: false + int1: 2 + int2: 3 +``` diff --git a/tests/docs/base/40_8calculation_multi_variable.md b/tests/results/test_namespace_examples/40_8calculation_multi_variable.md similarity index 97% rename from tests/docs/base/40_8calculation_multi_variable.md rename to tests/results/test_namespace_examples/40_8calculation_multi_variable.md index 40a3fb6..49885ad 100644 --- a/tests/docs/base/40_8calculation_multi_variable.md +++ b/tests/results/test_namespace_examples/40_8calculation_multi_variable.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: - description: a first variable - default: - - variable: _.var2 - - variable: _.var3 -var2: no # a second variable -var3: yes # a third variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -23,3 +10,14 @@ var3: yes # a third variable | **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 | +# 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.md b/tests/results/test_namespace_examples/40_8calculation_multi_variable_parent.md similarity index 97% rename from tests/docs/base/40_8calculation_multi_variable_parent.md rename to tests/results/test_namespace_examples/40_8calculation_multi_variable_parent.md index e590890..7e41457 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.md +++ b/tests/results/test_namespace_examples/40_8calculation_multi_variable_parent.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: no # a variable -fam1: # a family - var: - description: a calculated variable - default: - variable: __.var -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -28,3 +16,12 @@ fam1: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: no + fam1: + var: no +``` diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.md b/tests/results/test_namespace_examples/40_8calculation_multi_variable_parent2.md similarity index 97% rename from tests/docs/base/40_8calculation_multi_variable_parent2.md rename to tests/results/test_namespace_examples/40_8calculation_multi_variable_parent2.md index 2c85fbb..cc2cf1e 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.md +++ b/tests/results/test_namespace_examples/40_8calculation_multi_variable_parent2.md @@ -2,19 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -fam1: # first family - var: no # a variable -fam2: # second family - var: - description: a varaible - default: - variable: __.fam1.var -``` # Variables for "Rougail" ## first family @@ -33,3 +20,13 @@ fam2: # second family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + fam1: + var: no + fam2: + var: no +``` diff --git a/tests/docs/base/41_0choice_leader.md b/tests/results/test_namespace_examples/41_0choice_leader.md similarity index 95% rename from tests/docs/base/41_0choice_leader.md rename to tests/results/test_namespace_examples/41_0choice_leader.md index e762ca6..627b3b0 100644 --- a/tests/docs/base/41_0choice_leader.md +++ b/tests/results/test_namespace_examples/41_0choice_leader.md @@ -2,26 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: The leadership - type: leadership - leader: - description: The leader - multi: true - mandatory: false - follower1: - type: choice - description: A follower - choices: - - a - - b - - c -``` # Variables for "Rougail" ## The leadership @@ -35,3 +15,12 @@ This family contains lists of variable blocks. | **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 | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: a_choice +``` diff --git a/tests/results/test_namespace_examples/44_0leadership_hidden.md b/tests/results/test_namespace_examples/44_0leadership_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/44_0leadership_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/44_0leadership_leader_hidden.md b/tests/results/test_namespace_examples/44_0leadership_leader_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/44_0leadership_leader_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/44_1leadership_append_hidden_follower.md b/tests/results/test_namespace_examples/44_1leadership_append_hidden_follower.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/44_1leadership_append_hidden_follower.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/44_4disabled_calcultion_follower.md b/tests/results/test_namespace_examples/44_4disabled_calcultion_follower.md similarity index 96% rename from tests/docs/base/44_4disabled_calcultion_follower.md rename to tests/results/test_namespace_examples/44_4disabled_calcultion_follower.md index ea02708..100fd50 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.md +++ b/tests/results/test_namespace_examples/44_4disabled_calcultion_follower.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: true # a condition -leader: - description: a leadership - type: leadership - leader: - description: aleader - default: - - a - follower: - description: a follower - disabled: - jinja: | - {% if rougail.condition == "yes" %} - condition is yes - {% endif %} - description: if condition is yes -``` # Variables for "Rougail" | Variable                                                                                                    | Description                                                                                                 | @@ -41,3 +19,13 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + condition: true + leader: + - leader: a + follower: example +``` diff --git a/tests/docs/base/44_4leadership_mandatory.md b/tests/results/test_namespace_examples/44_4leadership_mandatory.md similarity index 96% rename from tests/docs/base/44_4leadership_mandatory.md rename to tests/results/test_namespace_examples/44_4leadership_mandatory.md index b9131b5..0aff1e4 100644 --- a/tests/docs/base/44_4leadership_mandatory.md +++ b/tests/results/test_namespace_examples/44_4leadership_mandatory.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: true - follower1: - description: a follower - mandatory: false -``` # Variables for "Rougail" ## a leadership @@ -31,3 +15,12 @@ This family contains lists of variable blocks. | **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` | A follower. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example +``` diff --git a/tests/docs/base/44_4leadership_mandatory_follower.md b/tests/results/test_namespace_examples/44_4leadership_mandatory_follower.md similarity index 95% rename from tests/docs/base/44_4leadership_mandatory_follower.md rename to tests/results/test_namespace_examples/44_4leadership_mandatory_follower.md index 2b82a82..4a9ff09 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.md +++ b/tests/results/test_namespace_examples/44_4leadership_mandatory_follower.md @@ -2,22 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - mandatory: false - follower: - description: a follower - mandatory: true -``` # Variables for "Rougail" ## a leadership @@ -31,3 +15,12 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower: example +``` diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.md b/tests/results/test_namespace_examples/44_5leadership_leader_hidden_calculation.md similarity index 95% rename from tests/docs/base/44_5leadership_leader_hidden_calculation.md rename to tests/results/test_namespace_examples/44_5leadership_leader_hidden_calculation.md index 8b537b1..5c848e0 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.md +++ b/tests/results/test_namespace_examples/44_5leadership_leader_hidden_calculation.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: no # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - hidden: - jinja: | - {% if __.condition == "no" %} - condition is no - {% endif %} - description: if condition is no - mandatory: false - follower: # a follower -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -42,3 +21,13 @@ This family contains lists of variable blocks. | **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. | +# 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.md b/tests/results/test_namespace_examples/44_6leadership_follower_disabled_calculation.md similarity index 96% rename from tests/docs/base/44_6leadership_follower_disabled_calculation.md rename to tests/results/test_namespace_examples/44_6leadership_follower_disabled_calculation.md index eeeb98e..042dc81 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.md +++ b/tests/results/test_namespace_examples/44_6leadership_follower_disabled_calculation.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -condition: yes # a condition -leader: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower: - description: a follower - disabled: - jinja: | - {% if __.condition == "yes" %} - disabled - {% endif %} - description: if condition is yes -``` # Variables for "Rougail" | Variable                                                                                                   | Description                                                                                                | @@ -40,3 +19,13 @@ This family contains lists of variable blocks. | **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. | +# 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.md b/tests/results/test_namespace_examples/44_9calculated_default_leadership_leader.md similarity index 93% rename from tests/docs/base/44_9calculated_default_leadership_leader.md rename to tests/results/test_namespace_examples/44_9calculated_default_leadership_leader.md index d00286b..54ce71f 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.md +++ b/tests/results/test_namespace_examples/44_9calculated_default_leadership_leader.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -leader: - description: leader - type: leadership - leader: # a leader - - a - - b - follower: - description: a follower - disabled: - jinja: | - {% if _.leader == "a" %} - the value of "leader" is "a" - {% endif %} - description: if the value of "leader" is "a" - default: - variable: _.leader -``` # Variables for "Rougail" ## rougail.leader @@ -37,3 +15,14 @@ This family contains lists of variable blocks. | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: a + follower: a + - leader: b + follower: b +``` diff --git a/tests/results/test_namespace_examples/60_0family_dynamic.md b/tests/results/test_namespace_examples/60_0family_dynamic.md new file mode 100644 index 0000000..bf94780 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_0.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_1_0.md rename to tests/results/test_namespace_examples/60_0family_dynamic_1_0.md index 3baae68..ace1508 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.md +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_0.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -var: - description: A suffix variable - multi: true - default: - - val1 - - val2 -dyn: - type: dynamic - variable: rougail.var - vardyn: - description: Dynamic variable - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -38,3 +20,16 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.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/results/test_namespace_examples/60_0family_dynamic_1_0_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_empty.md new file mode 100644 index 0000000..6c4954e --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_empty.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.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/results/test_namespace_examples/60_0family_dynamic_1_0_type.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_type.md new file mode 100644 index 0000000..2c537c3 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_type.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_0family_dynamic_1_0_type_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_type_empty.md new file mode 100644 index 0000000..f4d2e99 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_0_type_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_0family_dynamic_1_1.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_1.md new file mode 100644 index 0000000..ea04bdd --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_1.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_0family_dynamic_1_1_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_1_1_empty.md new file mode 100644 index 0000000..460e676 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_1_1_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_0family_dynamic_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_empty.md new file mode 100644 index 0000000..535ef39 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_empty.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable. | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynexample: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - example + dynexample: + var: example +``` diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.md b/tests/results/test_namespace_examples/60_0family_dynamic_jinja_number.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_jinja_number.md rename to tests/results/test_namespace_examples/60_0family_dynamic_jinja_number.md index 8294e13..e24376b 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.md +++ b/tests/results/test_namespace_examples/60_0family_dynamic_jinja_number.md @@ -2,26 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - 1 - - 2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family -var2: - description: a variable - default: - jinja: | - {{ rougail.dyn1.var }} - description: get the value of rougail.dyn1.var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -44,3 +24,17 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - 1 + - 2 + dyn1: + var: val + dyn2: + var: val + var2: val +``` diff --git a/tests/results/test_namespace_examples/60_0family_dynamic_jinja_number_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_jinja_number_empty.md new file mode 100644 index 0000000..c189d50 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_jinja_number_empty.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`number`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- 1
- 2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: 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. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - 1 + - 2 + dyn1: + var: val + dyn2: + var: val + var2: val +``` diff --git a/tests/results/test_namespace_examples/60_0family_dynamic_no_description.md b/tests/results/test_namespace_examples/60_0family_dynamic_no_description.md new file mode 100644 index 0000000..ef44001 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_no_description.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "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 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + +# 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/results/test_namespace_examples/60_0family_dynamic_no_description_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_no_description_empty.md new file mode 100644 index 0000000..9994929 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_no_description_empty.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Var. | + +# 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/results/test_namespace_examples/60_0family_dynamic_static.md b/tests/results/test_namespace_examples/60_0family_dynamic_static.md new file mode 100644 index 0000000..79d7c8f --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_static.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_0family_dynamic_test.md b/tests/results/test_namespace_examples/60_0family_dynamic_test.md new file mode 100644 index 0000000..b8f67d5 --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_test.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A dynamic variable. | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - val1 + - val2 + 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_variable_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_variable_empty.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_variable_empty.md rename to tests/results/test_namespace_examples/60_0family_dynamic_variable_empty.md index 3d3d18e..aed80da 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.md +++ b/tests/results/test_namespace_examples/60_0family_dynamic_variable_empty.md @@ -2,18 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: [] # a suffix variable -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: val # a variable inside dynamic family -``` # Variables for "Rougail" | Variable                                                                                                                    | Description                                                                                                                 | @@ -32,3 +20,21 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: 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.md b/tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix.md similarity index 97% rename from tests/docs/base/60_0family_dynamic_variable_suffix.md rename to tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix.md index abcc3a7..9d67f8c 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.md +++ b/tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix.md @@ -2,20 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: a value # A dynamic variable with suffix {{ identifier }} -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -34,3 +20,16 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +``` diff --git a/tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix_empty.md b/tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix_empty.md new file mode 100644 index 0000000..8cb551e --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_dynamic_variable_suffix_empty.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable with suffix *val1*.
A dynamic variable with suffix *val2*.
**Default**: a value | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + var: + - val1 + - val2 +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: a value + dynval2: + var: a value +``` diff --git a/tests/results/test_namespace_examples/60_0family_empty.md b/tests/results/test_namespace_examples/60_0family_empty.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_empty.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/results/test_namespace_examples/60_0family_hidden.md b/tests/results/test_namespace_examples/60_0family_hidden.md new file mode 100644 index 0000000..3fc684d --- /dev/null +++ b/tests/results/test_namespace_examples/60_0family_hidden.md @@ -0,0 +1,4 @@ +--- +gitea: none +include_toc: true +--- diff --git a/tests/docs/base/60_0family_mode.md b/tests/results/test_namespace_examples/60_0family_mode.md similarity index 96% rename from tests/docs/base/60_0family_mode.md rename to tests/results/test_namespace_examples/60_0family_mode.md index 3cececb..118b9c0 100644 --- a/tests/docs/base/60_0family_mode.md +++ b/tests/results/test_namespace_examples/60_0family_mode.md @@ -2,17 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -family: # a family - var: - description: A variable - mode: basic - default: non -``` # Variables for "Rougail" ## a family @@ -23,3 +12,11 @@ family: # a family |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable.
**Default**: non | +# Example with all variables modifiable + +```yaml +--- +rougail: + family: + var: non +``` diff --git a/tests/docs/base/60_1family_dynamic_jinja.md b/tests/results/test_namespace_examples/60_1family_dynamic_jinja.md similarity index 96% rename from tests/docs/base/60_1family_dynamic_jinja.md rename to tests/results/test_namespace_examples/60_1family_dynamic_jinja.md index 52dbd9c..eed61ae 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.md +++ b/tests/results/test_namespace_examples/60_1family_dynamic_jinja.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - jinja: | - {% for val in _.var %} - {{ loop.index }} - {% endfor %} - description: index of suffix value - var: val # a dynamic variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -38,3 +20,16 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*1*.var**
**rougail.dyn*2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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.md b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group.md similarity index 97% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md rename to tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group.md index 0d79409..cc49e6c 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.md +++ b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - family: # a family - var: # with a variable -var2: - description: a second variable - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -49,3 +28,31 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: the value of var. | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: 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.md b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2.md similarity index 96% rename from tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md rename to tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2.md index 4c02e26..6a697e4 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.md +++ b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - family: - description: a family inside dynamic family - var: - description: a dynamic variable - default: - type: identifier -var2: - description: a varible outside dynamic family - default: - jinja: | - {{ _.dynval1.family.var }} - description: the value of var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -53,3 +28,19 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + family: + var: val1 + dynval2: + family: + var: val2 + var2: val1 +``` diff --git a/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md new file mode 100644 index 0000000..5fb3e21 --- /dev/null +++ b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_2_empty.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a family inside dynamic family + +`standard` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A varible outside dynamic family.
**Default**: 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/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md new file mode 100644 index 0000000..b0353b5 --- /dev/null +++ b/tests/results/test_namespace_examples/60_2family_dynamic_jinja_fill_sub_group_empty.md @@ -0,0 +1,58 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +### a family + +`basic` + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | With a variable. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: the value of var. | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + family: + var: example + dynval2: + family: + var: 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_outside_calc.md b/tests/results/test_namespace_examples/60_2family_dynamic_outside_calc.md similarity index 97% rename from tests/docs/base/60_2family_dynamic_outside_calc.md rename to tests/results/test_namespace_examples/60_2family_dynamic_outside_calc.md index 21e2edd..6bbda8f 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.md +++ b/tests/results/test_namespace_examples/60_2family_dynamic_outside_calc.md @@ -2,26 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: # a suffx variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var1 - var: val # a dynamic variable -newvar: - description: a second variable - default: - jinja: | - {{ _.dynval1.var }} - description: the value of var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -44,3 +24,17 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A second variable.
**Default**: 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/results/test_namespace_examples/60_2family_dynamic_outside_calc_empty.md b/tests/results/test_namespace_examples/60_2family_dynamic_outside_calc_empty.md new file mode 100644 index 0000000..feeac27 --- /dev/null +++ b/tests/results/test_namespace_examples/60_2family_dynamic_outside_calc_empty.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffx variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: val | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.newvar**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A second variable.
**Default**: 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.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc2.md similarity index 96% rename from tests/docs/base/60_5family_dynamic_calc2.md rename to tests/results/test_namespace_examples/60_5family_dynamic_calc2.md index 17f16bd..cdae3fb 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc2.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var: # A suffix variable - - val1 - - val2 - -var2: # a second variable - -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - hidden: - jinja: | - {% if _.var2 == "no" %} - var2 is no - {% endif %} - description: if var2 is no - - vardyn: val # a dynamic variable -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -48,3 +23,24 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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/results/test_namespace_examples/60_5family_dynamic_calc2_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc2_empty.md new file mode 100644 index 0000000..cb10ae4 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc2_empty.md @@ -0,0 +1,46 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A second variable. | + +## A dynamic family + +`standard` *`hidden`* + +**Hidden**: if var2 is no. + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix.md similarity index 97% rename from tests/docs/base/60_5family_dynamic_calc_suffix.md rename to tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix.md index 869c8fa..a5aa075 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix.md @@ -2,30 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var1: - description: A suffix variable - default: - - val1 - - val2 - -dyn{{ identifier }}: - dynamic: - variable: _.var1 - - var: - description: A dynamic variable - -var2: - description: A variable calculated - default: - variable: rougail.dynval1.var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -48,3 +24,27 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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". | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: 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.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2.md similarity index 97% rename from tests/docs/base/60_5family_dynamic_calc_suffix2.md rename to tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2.md index 3df5e8e..ef7770f 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2.md @@ -2,23 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: Suffix has value - default: - type: identifier -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -37,3 +20,16 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2_empty.md new file mode 100644 index 0000000..a894c40 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix2_empty.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Suffix has value.
**Default**: the value of the identifier. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_disabled.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_disabled.md new file mode 100644 index 0000000..312525a --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_disabled.md @@ -0,0 +1,38 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- val2 + +| Variable                                                                                                             | Description                                                                                                          | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A dynamic variable.
**Disabled**: when the identifier is "val1". | + +# 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/results/test_namespace_examples/60_5family_dynamic_calc_suffix_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_empty.md new file mode 100644 index 0000000..06f8aec --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_empty.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: 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_param.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param.md similarity index 96% rename from tests/docs/base/60_5family_dynamic_calc_suffix_param.md rename to tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param.md index e6b1825..8947c09 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param.md @@ -2,28 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - default: - jinja: | - {{ identifier }} - params: - identifier: - type: identifier - description: from suffix -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -42,3 +20,16 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: from suffix. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: val1 + dynval2: + var: val2 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param_empty.md new file mode 100644 index 0000000..6cecfa0 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_suffix_param_empty.md @@ -0,0 +1,35 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A dynamic variable.
**Default**: 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.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_variable.md similarity index 97% rename from tests/docs/base/60_5family_dynamic_calc_variable.md rename to tests/results/test_namespace_examples/60_5family_dynamic_calc_variable.md index e5a49a1..a5aa075 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_variable.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var1: - description: A suffix variable - default: - - val1 - - val2 -dyn{{ identifier }}: - dynamic: - variable: _.var1 - propertyerror: false - var: - description: A dynamic variable -var2: - description: A variable calculated - default: - variable: _.dynval1.var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -45,3 +24,27 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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". | +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: example +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + var1: + - val1 + - val2 + dynval1: + var: example + dynval2: + var: example + var2: example +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_calc_variable_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_calc_variable_empty.md new file mode 100644 index 0000000..06f8aec --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_calc_variable_empty.md @@ -0,0 +1,50 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## rougail.dyn*val1* or rougail.dyn*val2* + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var1". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + dynval1: + var: example + dynval2: + var: 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.md b/tests/results/test_namespace_examples/60_5family_dynamic_hidden_suffix.md similarity index 93% rename from tests/docs/base/60_5family_dynamic_hidden_suffix.md rename to tests/results/test_namespace_examples/60_5family_dynamic_hidden_suffix.md index 923e4ea..35fac8b 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_hidden_suffix.md @@ -2,34 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -dyn{{ identifier }}: - description: a dynamic family - dynamic: - - val1 - - val2 - hidden: - jinja: | - {% if suffix == 'val2' %} - disabled - {% endif %} - params: - suffix: - type: identifier - description: if suffix == 'val2' - - var: - description: a variable - mandatory: false - family: # a family - var: - description: a new variable - mandatory: false -``` # Variables for "Rougail" ## a dynamic family @@ -54,3 +26,17 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.dyn*val1*.family.var**
**rougail.dyn*val2*.family.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A new variable. | +# Example with all variables modifiable + +```yaml +--- +rougail: + dynval1: + var: example + family: + var: example + dynval2: + var: example + family: + var: example +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_unknown_suffix_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_unknown_suffix_empty.md new file mode 100644 index 0000000..be6e493 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_unknown_suffix_empty.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2
- val3
- val4 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                | Description                                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
**rougail.*val3*_dyn.var1**
**rougail.*val4*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 1.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**rougail.*val2*_dyn.var2**
**rougail.*val3*_dyn.var2**
**rougail.*val4*_dyn.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 2.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1"
- the value of the variable "rougail.*val3*_dyn.var1"
- the value of the variable "rougail.*val4*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**rougail.*val2*_dyn.var3**
**rougail.*val3*_dyn.var3**
**rougail.*val4*_dyn.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable 3.
**Default**:
- the value of the variable "rougail.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1"
- the value of the variable "rougail.*val3*_dyn.var1"
- the value of the variable "rougail.*val4*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**rougail.*val2*_dyn.var4**
**rougail.*val3*_dyn.var4**
**rougail.*val4*_dyn.var4**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A variable 4.
**Default**: the value of the variable "rougail.val4_dyn.var1".
**Disabled**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + - val3 + - val4 + val1_dyn: + var1: val1 + var2: val1 + var3: val1 + var4: val4 + val2_dyn: + var1: val2 + var2: val2 + var3: val2 + var4: val4 + val3_dyn: + var1: val3 + var2: val3 + var3: val3 + var4: val4 + val4_dyn: + var1: val4 + var2: val4 + var3: val4 + var4: val4 +``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside.md similarity index 96% rename from tests/docs/base/60_5family_dynamic_variable_outside.md rename to tests/results/test_namespace_examples/60_5family_dynamic_variable_outside.md index 4c030c4..1a43c6a 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside.md @@ -2,29 +2,6 @@ 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: - variable: rougail.my_dyn_family_{{ identifier }}.var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -47,3 +24,19 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.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_outside2.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2.md similarity index 96% rename from tests/docs/base/60_5family_dynamic_variable_outside2.md rename to tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2.md index 7a2a4ae..db4f547 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside2.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2.md @@ -2,33 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' - -var2: - description: a variable - multi: true - default: - variable: rougail.my_dyn_family_{{ identifier }}.var - -var: # a suffix variable - - val1 - - val2 - -my_dyn_family_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - - var: - description: a variable inside a dynamic family - default: - type: identifier - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -48,3 +21,19 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.my_dyn_family_*val1*.var**
**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**: the value of the identifier. | +# Example with all variables modifiable + +```yaml +--- +rougail: + var2: + - val1 + - val2 + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2_empty.md new file mode 100644 index 0000000..e89a310 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside2_empty.md @@ -0,0 +1,39 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.var" | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var2: + - val1 + - val2 + var: + - val1 + - val2 + my_dyn_family_val1: + var: val1 + my_dyn_family_val2: + var: val2 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_empty.md new file mode 100644 index 0000000..66361a1 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_empty.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the 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_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.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.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja.md similarity index 96% rename from tests/docs/base/60_5family_dynamic_variable_outside_jinja.md rename to tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja.md index 9a81b8b..1734502 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja.md @@ -2,35 +2,6 @@ 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 for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -53,3 +24,19 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: depends on a calculation. | +# 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/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja_empty.md new file mode 100644 index 0000000..bad7c3c --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_jinja_empty.md @@ -0,0 +1,42 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.var**
**rougail.my_dyn_family_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable inside a dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A variable.
**Default**: depends on a calculation. | + +# 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/results/test_namespace_examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md new file mode 100644 index 0000000..7a19590 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_sub_suffix_empty.md @@ -0,0 +1,56 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a sub dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.my_dyn_family_*val1*.subdyn_*val1*.var**
**rougail.my_dyn_family_*val1*.subdyn_*val2*.var**
**rougail.my_dyn_family_*val2*.subdyn_*val1*.var**
**rougail.my_dyn_family_*val2*.subdyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside a sub dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A variable.
**Default**:
- the value of the variable "rougail.my_dyn_family_*val1*.subdyn_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val1*.subdyn_*val2*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.subdyn_*val1*.var"
- the value of the variable "rougail.my_dyn_family_*val2*.subdyn_*val2*.var" | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + my_dyn_family_val1: + subdyn_val1: + var: val1 + subdyn_val2: + var: val2 + my_dyn_family_val2: + subdyn_val1: + var: val1 + subdyn_val2: + var: val2 + var2: + - val1 + - val2 +``` diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix.md similarity index 97% rename from tests/docs/base/60_5family_dynamic_variable_outside_suffix.md rename to tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix.md index 735d775..b0990e5 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.md +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix.md @@ -2,27 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn_{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - var: - description: a variable inside dynamic family - default: - type: identifier -var2: - description: a variable - default: - variable: _.dyn_val1.var -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -45,3 +24,17 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **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". | +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dyn_val1: + var: val1 + dyn_val2: + var: val2 + var2: val1 +``` diff --git a/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix_empty.md b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix_empty.md new file mode 100644 index 0000000..41b4af8 --- /dev/null +++ b/tests/results/test_namespace_examples/60_5family_dynamic_variable_outside_suffix_empty.md @@ -0,0 +1,40 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Asuffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn_*val1*.var**
**rougail.dyn_*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable inside dynamic family.
**Default**: the value of the identifier. | + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A variable.
**Default**:
- the value of the variable "rougail.dyn_*val1*.var"
- the value of the variable "rougail.dyn_*val2*.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.md b/tests/results/test_namespace_examples/60_6family_dynamic_inside.md similarity index 95% rename from tests/docs/base/60_6family_dynamic_inside.md rename to tests/results/test_namespace_examples/60_6family_dynamic_inside.md index 97a0e8e..d8f165a 100644 --- a/tests/docs/base/60_6family_dynamic_inside.md +++ b/tests/results/test_namespace_examples/60_6family_dynamic_inside.md @@ -2,36 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 - -'{{ identifier }}_dyn': - description: a dynamic family - dynamic: - variable: _.var - var1: - description: value is suffix - default: - type: identifier - var2: - description: value is first variable - default: - variable: rougail.{{ identifier }}_dyn.var1 - var3: - description: value is relative first variable - default: - variable: _.var1 - var4: - description: value is first variable of val1 - default: - variable: rougail.val1_dyn.var1 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -53,3 +23,22 @@ This family builds families dynamically. | **rougail.*val1*_dyn.var3**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | | **rougail.*val1*_dyn.var4**
**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". | +# 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/results/test_namespace_examples/60_6family_dynamic_inside_empty.md b/tests/results/test_namespace_examples/60_6family_dynamic_inside_empty.md new file mode 100644 index 0000000..61c88c3 --- /dev/null +++ b/tests/results/test_namespace_examples/60_6family_dynamic_inside_empty.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.*val1*_dyn.var1**
**rougail.*val2*_dyn.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Value is suffix.
**Default**: the value of the identifier. | +| **rougail.*val1*_dyn.var2**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var3**
**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.*val1*_dyn.var1"
- the value of the variable "rougail.*val2*_dyn.var1" | +| **rougail.*val1*_dyn.var4**
**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". | + +# 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.md b/tests/results/test_namespace_examples/60_6family_dynamic_leadership.md similarity index 96% rename from tests/docs/base/60_6family_dynamic_leadership.md rename to tests/results/test_namespace_examples/60_6family_dynamic_leadership.md index a053122..f44d679 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.md +++ b/tests/results/test_namespace_examples/60_6family_dynamic_leadership.md @@ -2,31 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # a suffix variable - - val1 - - val2 -dyn{{ identifier }}: - description: a dynamic family - dynamic: - variable: _.var - leadership: - description: a leadership - type: leadership - leader: - description: a leader - multi: true - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mandatory: false -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -53,3 +28,22 @@ This family contains lists of variable blocks. | **rougail.dyn*val1*.leadership.follower1**
**rougail.dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | | **rougail.dyn*val1*.leadership.follower2**
**rougail.dyn*val2*.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/results/test_namespace_examples/60_6family_dynamic_leadership_empty.md b/tests/results/test_namespace_examples/60_6family_dynamic_leadership_empty.md new file mode 100644 index 0000000..996d56f --- /dev/null +++ b/tests/results/test_namespace_examples/60_6family_dynamic_leadership_empty.md @@ -0,0 +1,49 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A suffix variable.
**Examples**:
- val1
- val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +### a leadership + +`basic` + +This family contains lists of variable blocks. + +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.leadership.leader**
**rougail.dyn*val2*.leadership.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | +| **rougail.dyn*val1*.leadership.follower1**
**rougail.dyn*val2*.leadership.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` | A follower1. | +| **rougail.dyn*val1*.leadership.follower2**
**rougail.dyn*val2*.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.md b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic.md similarity index 93% rename from tests/docs/base/60_6family_dynamic_sub_dynamic.md rename to tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic.md index 7d972ec..317ae0f 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.md +++ b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic.md @@ -2,54 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -var: # A identifier variable - - val1 - - val2 -dyn{{ identifier }}: - description: A dynamic family - dynamic: - variable: _.var - var: - description: A dynamic variable - multi: true - default: - jinja: | - {% for val in __.var %} - t{{ val }} - {% endfor %} - description: add 't' to each var value - dyn_{{ identifier }}: - description: a Second dynamic variable - dynamic: - variable: rougail.dyn{{ identifier }}.var - var: - description: A variable dynamic - default: - type: identifier - var_identifier: - description: identifier from first family - default: - type: identifier - identifier: 0 - var_identifiers: - description: merge identifiers - default: - jinja: | - {{ s1 }}-{{ s2 }} - params: - s1: - type: identifier - identifier: 0 - s2: - type: identifier - identifier: 1 - description: join identifier 1 et identifier 2 -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -82,3 +34,36 @@ This family builds families dynamically. | **rougail.dyn*val1*.dyn_*tval1*.var_identifier**
**rougail.dyn*val1*.dyn_*tval2*.var_identifier**
**rougail.dyn*val2*.dyn_*tval1*.var_identifier**
**rougail.dyn*val2*.dyn_*tval2*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | | **rougail.dyn*val1*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val1*.dyn_*tval2*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval2*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: 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_identifier: val1 + var_identifiers: val1-tval1 + dyn_tval2: + var: tval2 + var_identifier: val1 + var_identifiers: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val2 + var_identifiers: val2-tval1 + dyn_tval2: + var: tval2 + var_identifier: val2 + var_identifiers: val2-tval2 +``` diff --git a/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_1_0.md b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_1_0.md new file mode 100644 index 0000000..4792873 --- /dev/null +++ b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_1_0.md @@ -0,0 +1,69 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A identifier variable.
**Default**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.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. | + +### a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.dyn{{ suffix }}.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*tval1*.var**
**rougail.dyn*val1*.dyn_*tval2*.var**
**rougail.dyn*val2*.dyn_*tval1*.var**
**rougail.dyn*val2*.dyn_*tval2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifier**
**rougail.dyn*val1*.dyn_*tval2*.var_identifier**
**rougail.dyn*val2*.dyn_*tval1*.var_identifier**
**rougail.dyn*val2*.dyn_*tval2*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val1*.dyn_*tval2*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval1*.var_identifiers**
**rougail.dyn*val2*.dyn_*tval2*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: 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_identifier: val1 + var_identifiers: val1-tval1 + dyn_tval2: + var: tval2 + var_identifier: val1 + var_identifiers: val1-tval2 + dynval2: + var: + - tval1 + - tval2 + dyn_tval1: + var: tval1 + var_identifier: val2 + var_identifiers: val2-tval1 + dyn_tval2: + var: tval2 + var_identifier: val2 + var_identifiers: val2-tval2 +``` diff --git a/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_empty.md b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_empty.md new file mode 100644 index 0000000..5e89c94 --- /dev/null +++ b/tests/results/test_namespace_examples/60_6family_dynamic_sub_dynamic_empty.md @@ -0,0 +1,59 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                           | Description                                                                                                        | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | A identifier variable.
**Examples**:
- val1
- val2 | + +## A dynamic family + +`standard` + +This family builds families dynamically. + +**Identifiers**: the value of the variable "rougail.var". + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.var**
**rougail.dyn*val2*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A dynamic variable.
**Default**: add 't' to each var value. | + +### a Second dynamic variable + +`standard` + +This family builds families dynamically. + +**Identifiers**:
- the value of the variable "rougail.dyn*val1*.var"
- the value of the variable "rougail.dyn*val2*.var" + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.dyn_*example*.var**
**rougail.dyn*val2*.dyn_*example*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A variable dynamic.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*example*.var_identifier**
**rougail.dyn*val2*.dyn_*example*.var_identifier**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Identifier from first family.
**Default**: the value of the identifier. | +| **rougail.dyn*val1*.dyn_*example*.var_identifiers**
**rougail.dyn*val2*.dyn_*example*.var_identifiers**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Merge identifiers.
**Default**: join identifier 1 et identifier 2. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + var: + - val1 + - val2 + dynval1: + var: + - example + dyn_example: + var: example + var_identifier: val1 + var_identifiers: val1-example + dynval2: + var: + - example + dyn_example: + var: example + var_identifier: val2 + var_identifiers: val2-example +``` diff --git a/tests/docs/base/60_9extra_dynamic.md b/tests/results/test_namespace_examples/60_9extra_dynamic.md similarity index 98% rename from tests/docs/base/60_9extra_dynamic.md rename to tests/results/test_namespace_examples/60_9extra_dynamic.md index 90535db..10343f4 100644 --- a/tests/docs/base/60_9extra_dynamic.md +++ b/tests/results/test_namespace_examples/60_9extra_dynamic.md @@ -2,24 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: 1.1 -var: # a variable - - a -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: 1.1 -dyn_{{ identifier }}: - dynamic: - variable: rougail.var - var: -``` # Variables for "Rougail" | Variable                                                                                                                       | Description                                                                                                                    | @@ -40,3 +22,22 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/60_9extra_dynamic_extra.md similarity index 97% rename from tests/docs/base/60_9extra_dynamic_extra.md rename to tests/results/test_namespace_examples/60_9extra_dynamic_extra.md index 7be5f77..8c7298e 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.md +++ b/tests/results/test_namespace_examples/60_9extra_dynamic_extra.md @@ -2,32 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -general: - description: général - varname: - type: string - description: No change - multi: true - default: - - a -version: '1.0' -``` -# dictionaries/extra/00-base.yml - -```yaml ---- -version: '1.1' -var: # a varaible - - a -dyn_{{ identifier }}: - dynamic: - variable: _.var - var: -``` # Variables for "Rougail" ## général @@ -56,3 +30,25 @@ This family builds families dynamically. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **extra.dyn_*a*.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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/results/test_namespace_examples/60_9family_dynamic_calc_both.md b/tests/results/test_namespace_examples/60_9family_dynamic_calc_both.md new file mode 100644 index 0000000..9fc7118 --- /dev/null +++ b/tests/results/test_namespace_examples/60_9family_dynamic_calc_both.md @@ -0,0 +1,43 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A suffix variable.
**Default**: val2 | + +## a dynamic family + +`basic` + +This family builds families dynamically. + +**Identifiers**:
- val1
- the value of the variable "rougail.var". + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.dyn*val1*.vardyn**
**rougail.dyn*val2*.vardyn**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | 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.md b/tests/results/test_namespace_examples/68_0family_leadership_mode.md similarity index 95% rename from tests/docs/base/68_0family_leadership_mode.md rename to tests/results/test_namespace_examples/68_0family_leadership_mode.md index b7ddb54..c74f645 100644 --- a/tests/docs/base/68_0family_leadership_mode.md +++ b/tests/results/test_namespace_examples/68_0family_leadership_mode.md @@ -2,25 +2,6 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.0' -leader: - description: A leadership - type: leadership - leader: - description: A leader - multi: true - mandatory: false - follower1: - description: a follower1 - mandatory: false - follower2: - description: a follower2 - mode: basic -``` # Variables for "Rougail" ## A leadership @@ -35,3 +16,13 @@ This family contains lists of variable blocks. | **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. | +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: example + follower1: example + follower2: example +``` diff --git a/tests/test_load.py b/tests/test_load.py index 04c3c7b..77b62f5 100644 --- a/tests/test_load.py +++ b/tests/test_load.py @@ -1,149 +1,105 @@ +import os from pytest import fixture # , raises from pathlib import Path -from ruamel.yaml import YAML -from rougail import RougailConfig -from rougail.output_doc import RougailOutputDoc +from rougail import Rougail +from rougail.output_doc import RougailOutputDoc as RougailOutput -from .custom import CustomOption +from rougail_tests.utils import get_structures_list, get_rougail_config, get_values_for_config -dico_dirs = Path('../rougail/tests/dictionaries') -test_ok = set() - -excludes = set([ +excludes = [] +excludes = [ '60_5family_dynamic_unknown_suffix', '60_5family_dynamic_variable_outside_sub_suffix', -]) +] -for test in dico_dirs.iterdir(): - if (test / 'tiramisu').is_dir() and test.name not in excludes: - test_ok.add(test.name) - -test_ok = list(test_ok) -test_ok.sort() - -# test_ok = ['60_0family_dynamic_variable_suffix'] +test_ok = get_structures_list(excludes) +#test_ok = [Path('../rougail-tests/structures/00_0version_underscore')] -@fixture(scope="module", params=test_ok) +os.environ['COLUMNS'] = '80' + + +def idfn(fixture_value): + return fixture_value.name + + +@fixture(scope="module", params=test_ok, ids=idfn) def test_dir(request): return request.param -def _test_dictionaries(test, output, namespace, examples=False): - test_dir = dico_dirs / test - rougailconfig = RougailConfig.copy() +def _test_dictionaries(test_dir, namespace, ext, *, examples=False): + rougailconfig = get_rougail_config(test_dir, namespace) + if not rougailconfig: + return + ################################## rougailconfig['step.output'] = 'doc' - rougailconfig['doc.output_format'] = output - rougailconfig['functions_files'] = [str(dico_dirs.parent / 'eosfunc' / 'test.py')] + rougailconfig['doc.output_format'] = ext + ext = {'github': 'md', 'asciidoc': 'adoc', 'json': 'json', 'console': 'sh'}.get(ext) if examples: rougailconfig['doc.with_example'] = True else: rougailconfig['doc.with_example'] = False -# rougailconfig['tiramisu_cache'] = "cache.py" - dirs = [str(test_dir / 'dictionaries' / 'rougail')] - subfolder = test_dir / 'dictionaries' / 'rougail2' - if subfolder.is_dir(): - dirs.append(str(subfolder)) - rougailconfig['main_dictionaries'] = dirs + ################################## + dir_name = 'test' if namespace: - rougailconfig['main_namespace'] = 'Rougail' - else: - rougailconfig['main_namespace'] = None - extra_dictionaries = {} - extras = list((test_dir / 'dictionaries').iterdir()) - extras.sort() - for extra in extras: - if extra.name in ['rougail', 'rougail2']: - continue - if extra.is_dir(): - extra_dictionaries[extra.name] = [str(extra)] - if extra_dictionaries: - rougailconfig['extra_dictionaries'] = extra_dictionaries - rougailconfig['custom_types']['custom'] = CustomOption - inventory = RougailOutputDoc(rougailconfig=rougailconfig) - try: - doc = inventory.formater.header() - except: - doc = '' - yaml = YAML() - len_subdir = len(str(dico_dirs)) + 1 - if extra_dictionaries: - all_dirs = [[rougailconfig['main_dictionaries']], rougailconfig['extra_dictionaries'].values()] - else: - all_dirs = [[rougailconfig['main_dictionaries']]] - for r in all_dirs: - for dirs in r: - for d in dirs: - for f in Path(d).iterdir(): - if f.name.endswith('.yml') or f.name.endswith('.yaml'): - try: - doc += inventory.formater.title(str(f)[len_subdir:].split('/', 1)[-1], 1) - except: - pass - with f.open(encoding="utf8") as file_fh: - objects = yaml.load(file_fh) - try: - doc += inventory.formater.yaml(objects) - except: - pass + dir_name += '_namespace' + elif (test_dir / 'force_namespace').is_file(): + return + ################################## if examples: - name = 'examples' - doc += inventory.gen_doc_examples() - else: - if namespace: - name = 'base' - else: - name = 'no_namespace' - doc += inventory.gen_doc() - doc_file = Path('tests') / 'docs' / name / (test_dir.name + {'github': '.md', 'asciidoc': '.adoc', 'json': '.json', 'console': '.sh'}.get(output)) - if not doc_file.is_file(): - with doc_file.open('w') as docfh: - docfh.write(doc) - with doc_file.open() as docfh: - result = docfh.read() - assert doc == result + dir_name += '_examples' + ################################## + rougail = Rougail(rougailconfig) + config = rougail.run() + generated_output = RougailOutput(config, rougailconfig=rougailconfig).run() + output_file = Path(__file__).parent / 'results' / dir_name / (test_dir.name + "." + ext) + if not output_file.is_file(): + if not output_file.parent.is_dir(): + output_file.parent.mkdir() + with output_file.open('w') as outfh: + outfh.write(generated_output) + with output_file.open() as outfh: + attented_output = outfh.read() + assert generated_output == attented_output, f'filename {output_file}' def test_dictionaries_json(test_dir): - _test_dictionaries(test_dir, 'json', True) + _test_dictionaries(test_dir, True, 'json') def test_dictionaries_console(test_dir): - _test_dictionaries(test_dir, 'console', True) + _test_dictionaries(test_dir, True, 'console') def test_dictionaries_github(test_dir): - _test_dictionaries(test_dir, 'github', True) + _test_dictionaries(test_dir, True, 'github') def test_dictionaries_asciidoc(test_dir): - _test_dictionaries(test_dir, 'asciidoc', True) - + _test_dictionaries(test_dir, True, 'asciidoc') +################ def test_dictionaries_examples(test_dir): - _test_dictionaries(test_dir, 'github', True, True) - + _test_dictionaries(test_dir, True, 'github', examples=True) +################ def test_dictionaries_json_no_namespace(test_dir): - if (dico_dirs / test_dir / 'force_namespace').is_file(): - return - _test_dictionaries(test_dir, 'json', False) + _test_dictionaries(test_dir, False, 'json') def test_dictionaries_console_no_namespace(test_dir): - if (dico_dirs / test_dir / 'force_namespace').is_file(): - return - _test_dictionaries(test_dir, 'console', False) + _test_dictionaries(test_dir, False, 'console') def test_dictionaries_github_no_namespace(test_dir): - if (dico_dirs / test_dir / 'force_namespace').is_file(): - return - _test_dictionaries(test_dir, 'github', False) + _test_dictionaries(test_dir, False, 'github') def test_dictionaries_asciidoc_no_namespace(test_dir): - if (dico_dirs / test_dir / 'force_namespace').is_file(): - return - _test_dictionaries(test_dir, 'asciidoc', False) + _test_dictionaries(test_dir, False, 'asciidoc') + +################ +def test_dictionaries_examples_no_namespace(test_dir): + _test_dictionaries(test_dir, False, 'github', examples=True)