From 60b4a068071aa8a8d498485aa16189a2b1dd67ec Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 10 Feb 2025 09:52:12 +0100 Subject: [PATCH] feat: output return status too --- src/rougail/output_doc/__init__.py | 2 +- src/rougail/output_doc/annotator.py | 2 +- src/rougail/output_doc/config.py | 2 +- src/rougail/output_doc/doc.py | 8 ++-- src/rougail/output_doc/example.py | 2 +- src/rougail/output_doc/i18n.py | 2 +- src/rougail/output_doc/output/__init__.py | 2 +- src/rougail/output_doc/output/asciidoc.py | 2 +- src/rougail/output_doc/output/console.py | 2 +- src/rougail/output_doc/output/github.py | 2 +- src/rougail/output_doc/output/ojson.py | 2 +- src/rougail/output_doc/utils.py | 2 +- tests/docs/examples/00_6port.md | 37 --------------- tests/docs/no_namespace/00_6port.adoc | 42 ----------------- tests/docs/no_namespace/00_6port.json | 1 - tests/docs/no_namespace/00_6port.sh | 38 ---------------- tests/results/test/00_6port.adoc | 19 +++++++- tests/results/test/00_6port.json | 2 +- tests/results/test/00_6port.md | 6 +-- tests/results/test/00_6port.sh | 26 ++++++----- tests/results/test/00_6secret.adoc | 18 ++++++++ tests/results/test/00_6secret.json | 1 + tests/results/test/00_6secret.md | 11 +++++ tests/results/test/00_6secret.sh | 16 +++++++ ..._5disabled_calculation_variable_multi.adoc | 19 ++++++++ ..._5disabled_calculation_variable_multi.json | 1 + ...4_5disabled_calculation_variable_multi.md} | 26 ++--------- ...04_5disabled_calculation_variable_multi.sh | 20 +++++++++ ...ip-calculation-outside-follower-first.adoc | 45 +++++++++++++++++++ ...ip-calculation-outside-follower-first.json | 1 + ...ship-calculation-outside-follower-first.md | 22 +++++++++ ...ship-calculation-outside-follower-first.sh | 39 ++++++++++++++++ ...hip-calculation-outside-follower-last.adoc | 45 +++++++++++++++++++ ...hip-calculation-outside-follower-last.json | 1 + ...rship-calculation-outside-follower-last.md | 22 +++++++++ ...rship-calculation-outside-follower-last.sh | 39 ++++++++++++++++ ...adership-calculation-outside-follower.adoc | 45 +++++++++++++++++++ ...adership-calculation-outside-follower.json | 1 + ...leadership-calculation-outside-follower.md | 22 +++++++++ ...leadership-calculation-outside-follower.sh | 40 +++++++++++++++++ ...ship-calculation-outside-leader-first.adoc | 45 +++++++++++++++++++ ...ship-calculation-outside-leader-first.json | 1 + ...ership-calculation-outside-leader-first.md | 22 +++++++++ ...ership-calculation-outside-leader-first.sh | 39 ++++++++++++++++ ...rship-calculation-outside-leader-last.adoc | 45 +++++++++++++++++++ ...rship-calculation-outside-leader-last.json | 1 + ...dership-calculation-outside-leader-last.md | 22 +++++++++ ...dership-calculation-outside-leader-last.sh | 39 ++++++++++++++++ ...leadership-calculation-outside-leader.adoc | 45 +++++++++++++++++++ ...leadership-calculation-outside-leader.json | 1 + ..._9leadership-calculation-outside-leader.md | 22 +++++++++ ..._9leadership-calculation-outside-leader.sh | 41 +++++++++++++++++ tests/results/test_examples/00_6port.md | 6 +-- tests/results/test_examples/00_6secret.md | 24 ++++++++++ ...04_5disabled_calculation_variable_multi.md | 26 +++++++++++ ...ship-calculation-outside-follower-first.md | 36 +++++++++++++++ ...rship-calculation-outside-follower-last.md | 36 +++++++++++++++ ...leadership-calculation-outside-follower.md | 37 +++++++++++++++ ...ership-calculation-outside-leader-first.md | 35 +++++++++++++++ ...dership-calculation-outside-leader-last.md | 35 +++++++++++++++ ..._9leadership-calculation-outside-leader.md | 37 +++++++++++++++ tests/results/test_namespace/00_6port.adoc | 19 +++++++- tests/results/test_namespace/00_6port.json | 2 +- tests/results/test_namespace/00_6port.md | 6 +-- tests/results/test_namespace/00_6port.sh | 26 ++++++----- tests/results/test_namespace/00_6secret.adoc | 18 ++++++++ tests/results/test_namespace/00_6secret.json | 1 + tests/results/test_namespace/00_6secret.md | 11 +++++ tests/results/test_namespace/00_6secret.sh | 16 +++++++ .../04_5disabled_calculation_multi.adoc | 25 +++++++++++ .../04_5disabled_calculation_multi.json | 1 + .../04_5disabled_calculation_multi.md | 12 +++++ .../04_5disabled_calculation_multi.sh | 27 +++++++++++ ..._5disabled_calculation_variable_multi.adoc | 19 ++++++++ ..._5disabled_calculation_variable_multi.json | 1 + ...04_5disabled_calculation_variable_multi.md | 11 +++++ ...04_5disabled_calculation_variable_multi.sh | 21 +++++++++ ...ip-calculation-outside-follower-first.adoc | 45 +++++++++++++++++++ ...ip-calculation-outside-follower-first.json | 1 + ...ship-calculation-outside-follower-first.md | 22 +++++++++ ...ship-calculation-outside-follower-first.sh | 39 ++++++++++++++++ ...hip-calculation-outside-follower-last.adoc | 45 +++++++++++++++++++ ...hip-calculation-outside-follower-last.json | 1 + ...rship-calculation-outside-follower-last.md | 22 +++++++++ ...rship-calculation-outside-follower-last.sh | 39 ++++++++++++++++ ...adership-calculation-outside-follower.adoc | 45 +++++++++++++++++++ ...adership-calculation-outside-follower.json | 1 + ...leadership-calculation-outside-follower.md | 22 +++++++++ ...leadership-calculation-outside-follower.sh | 40 +++++++++++++++++ ...ship-calculation-outside-leader-first.adoc | 45 +++++++++++++++++++ ...ship-calculation-outside-leader-first.json | 1 + ...ership-calculation-outside-leader-first.md | 22 +++++++++ ...ership-calculation-outside-leader-first.sh | 39 ++++++++++++++++ ...rship-calculation-outside-leader-last.adoc | 45 +++++++++++++++++++ ...rship-calculation-outside-leader-last.json | 1 + ...dership-calculation-outside-leader-last.md | 22 +++++++++ ...dership-calculation-outside-leader-last.sh | 39 ++++++++++++++++ ...leadership-calculation-outside-leader.adoc | 45 +++++++++++++++++++ ...leadership-calculation-outside-leader.json | 1 + ..._9leadership-calculation-outside-leader.md | 22 +++++++++ ..._9leadership-calculation-outside-leader.sh | 41 +++++++++++++++++ .../test_namespace_examples/00_6port.md | 6 +-- .../test_namespace_examples/00_6secret.md | 26 +++++++++++ .../04_5disabled_calculation_multi.md | 33 ++++++++++++++ ...04_5disabled_calculation_variable_multi.md | 28 ++++++++++++ ...ship-calculation-outside-follower-first.md | 37 +++++++++++++++ ...rship-calculation-outside-follower-last.md | 37 +++++++++++++++ ...leadership-calculation-outside-follower.md | 38 ++++++++++++++++ ...ership-calculation-outside-leader-first.md | 36 +++++++++++++++ ...dership-calculation-outside-leader-last.md | 36 +++++++++++++++ ..._9leadership-calculation-outside-leader.md | 38 ++++++++++++++++ tests/test_force_optional.py | 2 +- tests/test_load.py | 2 +- tests/test_mode.py | 2 +- 114 files changed, 2219 insertions(+), 193 deletions(-) delete mode 100644 tests/docs/examples/00_6port.md delete mode 100644 tests/docs/no_namespace/00_6port.adoc delete mode 100644 tests/docs/no_namespace/00_6port.json delete mode 100644 tests/docs/no_namespace/00_6port.sh create mode 100644 tests/results/test/00_6secret.adoc create mode 100644 tests/results/test/00_6secret.json create mode 100644 tests/results/test/00_6secret.md create mode 100644 tests/results/test/00_6secret.sh create mode 100644 tests/results/test/04_5disabled_calculation_variable_multi.adoc create mode 100644 tests/results/test/04_5disabled_calculation_variable_multi.json rename tests/{docs/no_namespace/00_6port.md => results/test/04_5disabled_calculation_variable_multi.md} (82%) create mode 100644 tests/results/test/04_5disabled_calculation_variable_multi.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-first.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-first.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-first.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-first.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-last.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-last.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-last.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower-last.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-follower.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-first.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-first.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-first.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-first.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-last.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-last.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-last.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader-last.sh create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader.adoc create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader.json create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader.md create mode 100644 tests/results/test/40_9leadership-calculation-outside-leader.sh create mode 100644 tests/results/test_examples/00_6secret.md create mode 100644 tests/results/test_examples/04_5disabled_calculation_variable_multi.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-follower-first.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-follower-last.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-follower.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-leader-first.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-leader-last.md create mode 100644 tests/results/test_examples/40_9leadership-calculation-outside-leader.md create mode 100644 tests/results/test_namespace/00_6secret.adoc create mode 100644 tests/results/test_namespace/00_6secret.json create mode 100644 tests/results/test_namespace/00_6secret.md create mode 100644 tests/results/test_namespace/00_6secret.sh create mode 100644 tests/results/test_namespace/04_5disabled_calculation_multi.adoc create mode 100644 tests/results/test_namespace/04_5disabled_calculation_multi.json create mode 100644 tests/results/test_namespace/04_5disabled_calculation_multi.md create mode 100644 tests/results/test_namespace/04_5disabled_calculation_multi.sh create mode 100644 tests/results/test_namespace/04_5disabled_calculation_variable_multi.adoc create mode 100644 tests/results/test_namespace/04_5disabled_calculation_variable_multi.json create mode 100644 tests/results/test_namespace/04_5disabled_calculation_variable_multi.md create mode 100644 tests/results/test_namespace/04_5disabled_calculation_variable_multi.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-follower.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.sh create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader.adoc create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader.json create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader.md create mode 100644 tests/results/test_namespace/40_9leadership-calculation-outside-leader.sh create mode 100644 tests/results/test_namespace_examples/00_6secret.md create mode 100644 tests/results/test_namespace_examples/04_5disabled_calculation_multi.md create mode 100644 tests/results/test_namespace_examples/04_5disabled_calculation_variable_multi.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-first.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-last.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-first.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-last.md create mode 100644 tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader.md diff --git a/src/rougail/output_doc/__init__.py b/src/rougail/output_doc/__init__.py index 907650d..9c87843 100644 --- a/src/rougail/output_doc/__init__.py +++ b/src/rougail/output_doc/__init__.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py index d64be78..620ed2e 100644 --- a/src/rougail/output_doc/annotator.py +++ b/src/rougail/output_doc/annotator.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 distribued with GPL-2 or later license diff --git a/src/rougail/output_doc/config.py b/src/rougail/output_doc/config.py index b3083ab..a3064aa 100644 --- a/src/rougail/output_doc/config.py +++ b/src/rougail/output_doc/config.py @@ -2,7 +2,7 @@ Config file for Rougail-doc Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/doc.py b/src/rougail/output_doc/doc.py index 4826a49..24c7f77 100644 --- a/src/rougail/output_doc/doc.py +++ b/src/rougail/output_doc/doc.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the @@ -96,10 +96,12 @@ class RougailOutputDoc(Examples): return_string = self.formater.run(self.informations, self.level) if self.with_example: return_string += self.gen_doc_examples() - return return_string + return True, return_string def print(self) -> None: - print(self.run()) + ret, data = self.run() + print(data) + return ret def _tiramisu_to_internal_object(self): config = self.conf.unrestraint diff --git a/src/rougail/output_doc/example.py b/src/rougail/output_doc/example.py index eb6537b..f55b23b 100644 --- a/src/rougail/output_doc/example.py +++ b/src/rougail/output_doc/example.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/i18n.py b/src/rougail/output_doc/i18n.py index af65524..789559c 100644 --- a/src/rougail/output_doc/i18n.py +++ b/src/rougail/output_doc/i18n.py @@ -1,6 +1,6 @@ """Internationalisation utilities Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/output/__init__.py b/src/rougail/output_doc/output/__init__.py index 490a0a4..77d3b52 100644 --- a/src/rougail/output_doc/output/__init__.py +++ b/src/rougail/output_doc/output/__init__.py @@ -1,6 +1,6 @@ """Loads output Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py index a4798aa..6679efe 100644 --- a/src/rougail/output_doc/output/asciidoc.py +++ b/src/rougail/output_doc/output/asciidoc.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/output/console.py b/src/rougail/output_doc/output/console.py index 46fbf6e..fa03b4e 100644 --- a/src/rougail/output_doc/output/console.py +++ b/src/rougail/output_doc/output/console.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py index 672ccca..26ff01f 100644 --- a/src/rougail/output_doc/output/github.py +++ b/src/rougail/output_doc/output/github.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/output/ojson.py b/src/rougail/output_doc/output/ojson.py index 349e2ce..45ea67d 100644 --- a/src/rougail/output_doc/output/ojson.py +++ b/src/rougail/output_doc/output/ojson.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/src/rougail/output_doc/utils.py b/src/rougail/output_doc/utils.py index fa6c7e8..36890b9 100644 --- a/src/rougail/output_doc/utils.py +++ b/src/rougail/output_doc/utils.py @@ -1,6 +1,6 @@ """ Silique (https://www.silique.fr) -Copyright (C) 2024 +Copyright (C) 2024-2025 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the diff --git a/tests/docs/examples/00_6port.md b/tests/docs/examples/00_6port.md deleted file mode 100644 index e074c18..0000000 --- a/tests/docs/examples/00_6port.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 -``` -# 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/no_namespace/00_6port.adoc b/tests/docs/no_namespace/00_6port.adoc deleted file mode 100644 index 9d00b7e..0000000 --- a/tests/docs/no_namespace/00_6port.adoc +++ /dev/null @@ -1,42 +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 - -[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/docs/no_namespace/00_6port.json b/tests/docs/no_namespace/00_6port.json deleted file mode 100644 index 99ef63a..0000000 --- a/tests/docs/no_namespace/00_6port.json +++ /dev/null @@ -1 +0,0 @@ -{"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/docs/no_namespace/00_6port.sh b/tests/docs/no_namespace/00_6port.sh deleted file mode 100644 index 41f2c9d..0000000 --- a/tests/docs/no_namespace/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 ┃ -┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ - - - - - - - -  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_6port.adoc b/tests/results/test/00_6port.adoc index d259fee..0ceb18a 100644 --- a/tests/results/test/00_6port.adoc +++ b/tests/results/test/00_6port.adoc @@ -7,18 +7,35 @@ **variable1** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | -A port variable. +A port variable. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed | **variable2** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with default value. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed + **Default**: 8080 | **variable3** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with integer default value. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed + **Default**: 8080 |==== diff --git a/tests/results/test/00_6port.json b/tests/results/test/00_6port.json index 99ef63a..4647fc7 100644 --- a/tests/results/test/00_6port.json +++ b/tests/results/test/00_6port.json @@ -1 +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 +{"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "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"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "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"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "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 index ad37dd3..daff213 100644 --- a/tests/results/test/00_6port.md +++ b/tests/results/test/00_6port.md @@ -6,7 +6,7 @@ include_toc: true | 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 | +| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed | +| **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | +| **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | diff --git a/tests/results/test/00_6port.sh b/tests/results/test/00_6port.sh index 50bc115..cd78dea 100644 --- a/tests/results/test/00_6port.sh +++ b/tests/results/test/00_6port.sh @@ -4,19 +4,25 @@ - - -  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 + Validators: + + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed + | | variable2 port standard mandatory + | A port variable with default value. Validators: + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed Default: 8080 + | | variable3 port standard mandatory + | A port variable with integer default value. Validators: + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed Default: 8080 + | diff --git a/tests/results/test/00_6secret.adoc b/tests/results/test/00_6secret.adoc new file mode 100644 index 0000000..2a5466a --- /dev/null +++ b/tests/results/test/00_6secret.adoc @@ -0,0 +1,18 @@ +== Variables + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**secret1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[secret]` `basic` `mandatory` | +The first variable. +| + +**secret2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[secret]` `standard` `mandatory` | +The second variable. + +**Default**: value +|==== + diff --git a/tests/results/test/00_6secret.json b/tests/results/test/00_6secret.json new file mode 100644 index 0000000..37c55ae --- /dev/null +++ b/tests/results/test/00_6secret.json @@ -0,0 +1 @@ +{"secret1": {"type": "variable", "properties": [{"type": "type", "name": "secret"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["secret1"], "names": ["secret1"], "descriptions": ["The first variable."]}, "secret2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "secret"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["secret2"], "names": ["secret2"], "descriptions": ["The second variable."]}} \ No newline at end of file diff --git a/tests/results/test/00_6secret.md b/tests/results/test/00_6secret.md new file mode 100644 index 0000000..ffea065 --- /dev/null +++ b/tests/results/test/00_6secret.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **secret1**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **secret2**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value | + diff --git a/tests/results/test/00_6secret.sh b/tests/results/test/00_6secret.sh new file mode 100644 index 0000000..7a44d49 --- /dev/null +++ b/tests/results/test/00_6secret.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + secret1 + secret basic mandatory The first variable. + secret2 + secret standard mandatory The second variable. + Default: value + diff --git a/tests/results/test/04_5disabled_calculation_variable_multi.adoc b/tests/results/test/04_5disabled_calculation_variable_multi.adoc new file mode 100644 index 0000000..6cdc5ef --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable_multi.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__` `unique` `multiple` | +A variable. + +**Disabled**: when the variable "condition" has the value "true". +|==== + diff --git a/tests/results/test/04_5disabled_calculation_variable_multi.json b/tests/results/test/04_5disabled_calculation_variable_multi.json new file mode 100644 index 0000000..4027811 --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable_multi.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\"."}, {"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/docs/no_namespace/00_6port.md b/tests/results/test/04_5disabled_calculation_variable_multi.md similarity index 82% rename from tests/docs/no_namespace/00_6port.md rename to tests/results/test/04_5disabled_calculation_variable_multi.md index 7cf5568..08e4a51 100644 --- a/tests/docs/no_namespace/00_6port.md +++ b/tests/results/test/04_5disabled_calculation_variable_multi.md @@ -2,28 +2,10 @@ gitea: none include_toc: true --- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -variable1: - description: a port variable - type: port -variable2: - description: a port variable with default value - type: port - default: '8080' -variable3: - description: a port variable with integer default value - type: port - default: 8080 -``` # Variables -| Variable                                                                                                 | Description                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `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 | +| 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`* `unique` `multiple` | A variable.
**Disabled**: when the variable "condition" has the value "true". | diff --git a/tests/results/test/04_5disabled_calculation_variable_multi.sh b/tests/results/test/04_5disabled_calculation_variable_multi.sh new file mode 100644 index 0000000..178fbeb --- /dev/null +++ b/tests/results/test/04_5disabled_calculation_variable_multi.sh @@ -0,0 +1,20 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + condition + boolean standard mandatory A condition. + Default: false + variable + string basic mandatory disabled A variable. + unique multiple + Disabled: when the variable + "condition" has the value "true". + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-first.adoc b/tests/results/test/40_9leadership-calculation-outside-follower-first.adoc new file mode 100644 index 0000000..e732bee --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-first.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-first.json b/tests/results/test/40_9leadership-calculation-outside-follower-first.json new file mode 100644 index 0000000..8478f30 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-first.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-first.md b/tests/results/test/40_9leadership-calculation-outside-follower-first.md new file mode 100644 index 0000000..fdca935 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-first.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-first.sh b/tests/results/test/40_9leadership-calculation-outside-follower-first.sh new file mode 100644 index 0000000..9ac7c3b --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-first.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory multiple A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-last.adoc b/tests/results/test/40_9leadership-calculation-outside-follower-last.adoc new file mode 100644 index 0000000..e732bee --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-last.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-last.json b/tests/results/test/40_9leadership-calculation-outside-follower-last.json new file mode 100644 index 0000000..8478f30 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-last.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-last.md b/tests/results/test/40_9leadership-calculation-outside-follower-last.md new file mode 100644 index 0000000..fdca935 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-last.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower-last.sh b/tests/results/test/40_9leadership-calculation-outside-follower-last.sh new file mode 100644 index 0000000..9ac7c3b --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower-last.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory multiple A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower.adoc b/tests/results/test/40_9leadership-calculation-outside-follower.adoc new file mode 100644 index 0000000..c1571ae --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: the value of the variable "leader.follower1". +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower.json b/tests/results/test/40_9leadership-calculation-outside-follower.json new file mode 100644 index 0000000..a1ae787 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "the value of the variable \"leader.follower1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-follower.md b/tests/results/test/40_9leadership-calculation-outside-follower.md new file mode 100644 index 0000000..3b33ef9 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: the value of the variable "leader.follower1". | + diff --git a/tests/results/test/40_9leadership-calculation-outside-follower.sh b/tests/results/test/40_9leadership-calculation-outside-follower.sh new file mode 100644 index 0000000..08ecc2d --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-follower.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory multiple A calculated variable. + Default: the value of the variable + "leader.follower1". + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-first.adoc b/tests/results/test/40_9leadership-calculation-outside-leader-first.adoc new file mode 100644 index 0000000..1ecd519 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-first.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-first.json b/tests/results/test/40_9leadership-calculation-outside-leader-first.json new file mode 100644 index 0000000..2695c65 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-first.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."]}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-first.md b/tests/results/test/40_9leadership-calculation-outside-leader-first.md new file mode 100644 index 0000000..a4c95f9 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-first.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-first.sh b/tests/results/test/40_9leadership-calculation-outside-leader-first.sh new file mode 100644 index 0000000..22ead76 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-first.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-last.adoc b/tests/results/test/40_9leadership-calculation-outside-leader-last.adoc new file mode 100644 index 0000000..1ecd519 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-last.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-last.json b/tests/results/test/40_9leadership-calculation-outside-leader-last.json new file mode 100644 index 0000000..2695c65 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-last.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."]}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-last.md b/tests/results/test/40_9leadership-calculation-outside-leader-last.md new file mode 100644 index 0000000..a4c95f9 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-last.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader-last.sh b/tests/results/test/40_9leadership-calculation-outside-leader-last.sh new file mode 100644 index 0000000..22ead76 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader-last.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader.adoc b/tests/results/test/40_9leadership-calculation-outside-leader.adoc new file mode 100644 index 0000000..3ab7b76 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader.adoc @@ -0,0 +1,45 @@ +== 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` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A calculated variable. + +**Default**: the value of the variable "leader.leader". +|==== + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader.json b/tests/results/test/40_9leadership-calculation-outside-leader.json new file mode 100644 index 0000000..b644476 --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader.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", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"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": "val11", "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": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "the value of the variable \"leader.leader\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}} \ No newline at end of file diff --git a/tests/results/test/40_9leadership-calculation-outside-leader.md b/tests/results/test/40_9leadership-calculation-outside-leader.md new file mode 100644 index 0000000..3d1de7b --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader.md @@ -0,0 +1,22 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A calculated variable.
**Default**: the value of the variable "leader.leader". | + diff --git a/tests/results/test/40_9leadership-calculation-outside-leader.sh b/tests/results/test/40_9leadership-calculation-outside-leader.sh new file mode 100644 index 0000000..2f503fe --- /dev/null +++ b/tests/results/test/40_9leadership-calculation-outside-leader.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + a leadership + +standard + +This family contains lists of variable blocks. + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + leader.leader + string standard mandatory unique A leader. + multiple + Default: + + + • value1 + • value2 + | | leader.follower1 string standard mandatory + | A follower. Default: val11 + | | leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + calculate + string standard mandatory unique A calculated variable. + multiple + Default: the value of the variable + "leader.leader". + diff --git a/tests/results/test_examples/00_6port.md b/tests/results/test_examples/00_6port.md index 42ff443..fcae169 100644 --- a/tests/results/test_examples/00_6port.md +++ b/tests/results/test_examples/00_6port.md @@ -6,9 +6,9 @@ include_toc: true | 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 | +| **variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed | +| **variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | +| **variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | # Example with mandatory variables not filled in diff --git a/tests/results/test_examples/00_6secret.md b/tests/results/test_examples/00_6secret.md new file mode 100644 index 0000000..80958f5 --- /dev/null +++ b/tests/results/test_examples/00_6secret.md @@ -0,0 +1,24 @@ +--- +gitea: none +include_toc: true +--- +# Variables + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **secret1**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **secret2**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value | + +# Example with mandatory variables not filled in + +```yaml +--- +secret1: secrets +``` +# Example with all variables modifiable + +```yaml +--- +secret1: secrets +secret2: value +``` diff --git a/tests/results/test_examples/04_5disabled_calculation_variable_multi.md b/tests/results/test_examples/04_5disabled_calculation_variable_multi.md new file mode 100644 index 0000000..81e4faa --- /dev/null +++ b/tests/results/test_examples/04_5disabled_calculation_variable_multi.md @@ -0,0 +1,26 @@ +--- +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`* `unique` `multiple` | 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/40_9leadership-calculation-outside-follower-first.md b/tests/results/test_examples/40_9leadership-calculation-outside-follower-first.md new file mode 100644 index 0000000..c4c2bea --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-follower-first.md @@ -0,0 +1,36 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: + - val11 +``` diff --git a/tests/results/test_examples/40_9leadership-calculation-outside-follower-last.md b/tests/results/test_examples/40_9leadership-calculation-outside-follower-last.md new file mode 100644 index 0000000..c4c2bea --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-follower-last.md @@ -0,0 +1,36 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: + - val11 +``` diff --git a/tests/results/test_examples/40_9leadership-calculation-outside-follower.md b/tests/results/test_examples/40_9leadership-calculation-outside-follower.md new file mode 100644 index 0000000..3d8bdca --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-follower.md @@ -0,0 +1,37 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: the value of the variable "leader.follower1". | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: + - val11 + - val11 +``` diff --git a/tests/results/test_examples/40_9leadership-calculation-outside-leader-first.md b/tests/results/test_examples/40_9leadership-calculation-outside-leader-first.md new file mode 100644 index 0000000..4b60019 --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-leader-first.md @@ -0,0 +1,35 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: value1 +``` diff --git a/tests/results/test_examples/40_9leadership-calculation-outside-leader-last.md b/tests/results/test_examples/40_9leadership-calculation-outside-leader-last.md new file mode 100644 index 0000000..6ee647e --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-leader-last.md @@ -0,0 +1,35 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: value2 +``` diff --git a/tests/results/test_examples/40_9leadership-calculation-outside-leader.md b/tests/results/test_examples/40_9leadership-calculation-outside-leader.md new file mode 100644 index 0000000..6631082 --- /dev/null +++ b/tests/results/test_examples/40_9leadership-calculation-outside-leader.md @@ -0,0 +1,37 @@ +--- +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` `mandatory` `unique` `multiple` | A leader.
**Default**:
- value1
- value2 | +| **leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A calculated variable.
**Default**: the value of the variable "leader.leader". | + +# Example with all variables modifiable + +```yaml +--- +leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 +calculate: + - value1 + - value2 +``` diff --git a/tests/results/test_namespace/00_6port.adoc b/tests/results/test_namespace/00_6port.adoc index 103550b..82b58b2 100644 --- a/tests/results/test_namespace/00_6port.adoc +++ b/tests/results/test_namespace/00_6port.adoc @@ -7,18 +7,35 @@ **rougail.variable1** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `basic` `mandatory` | -A port variable. +A port variable. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed | **rougail.variable2** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with default value. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed + **Default**: 8080 | **rougail.variable3** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[port]` `standard` `mandatory` | A port variable with integer default value. + +**Validators**: + +* ports 1 to 1023 are allowed +* ports 1024 to 49151 are allowed +* ports greater than 49152 are allowed + **Default**: 8080 |==== diff --git a/tests/results/test_namespace/00_6port.json b/tests/results/test_namespace/00_6port.json index 9d87c32..3c070b5 100644 --- a/tests/results/test_namespace/00_6port.json +++ b/tests/results/test_namespace/00_6port.json @@ -1 +1 @@ -{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.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": ["rougail.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": ["rougail.variable3"], "names": ["variable3"], "descriptions": ["A port variable with integer default value."]}}}} \ No newline at end of file +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"variable1": {"type": "variable", "properties": [{"type": "type", "name": "port"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "paths": ["rougail.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"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "paths": ["rougail.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"}], "validators": ["ports 1 to 1023 are allowed", "ports 1024 to 49151 are allowed", "ports greater than 49152 are allowed"], "paths": ["rougail.variable3"], "names": ["variable3"], "descriptions": ["A port variable with integer default value."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/00_6port.md b/tests/results/test_namespace/00_6port.md index 6415824..02bd8f1 100644 --- a/tests/results/test_namespace/00_6port.md +++ b/tests/results/test_namespace/00_6port.md @@ -6,7 +6,7 @@ include_toc: true | 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 | +| **rougail.variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed | +| **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | +| **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | diff --git a/tests/results/test_namespace/00_6port.sh b/tests/results/test_namespace/00_6port.sh index bff89b4..3cfefeb 100644 --- a/tests/results/test_namespace/00_6port.sh +++ b/tests/results/test_namespace/00_6port.sh @@ -4,19 +4,25 @@ - - -  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 + Validators: + + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed + | | rougail.variable2 port standard mandatory + | A port variable with default value. Validators: + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed Default: 8080 + | | rougail.variable3 port standard mandatory + | A port variable with integer default value. Validators: + • ports 1 to 1023 are allowed + • ports 1024 to 49151 are allowed + • ports greater than 49152 are allowed Default: 8080 + | diff --git a/tests/results/test_namespace/00_6secret.adoc b/tests/results/test_namespace/00_6secret.adoc new file mode 100644 index 0000000..a63fe2f --- /dev/null +++ b/tests/results/test_namespace/00_6secret.adoc @@ -0,0 +1,18 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.secret1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[secret]` `basic` `mandatory` | +The first variable. +| + +**rougail.secret2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[secret]` `standard` `mandatory` | +The second variable. + +**Default**: value +|==== + diff --git a/tests/results/test_namespace/00_6secret.json b/tests/results/test_namespace/00_6secret.json new file mode 100644 index 0000000..b09780d --- /dev/null +++ b/tests/results/test_namespace/00_6secret.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"secret1": {"type": "variable", "properties": [{"type": "type", "name": "secret"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.secret1"], "names": ["secret1"], "descriptions": ["The first variable."]}, "secret2": {"type": "variable", "default": "value", "properties": [{"type": "type", "name": "secret"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.secret2"], "names": ["secret2"], "descriptions": ["The second variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/00_6secret.md b/tests/results/test_namespace/00_6secret.md new file mode 100644 index 0000000..cdb1fbe --- /dev/null +++ b/tests/results/test_namespace/00_6secret.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.secret1**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **rougail.secret2**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value | + diff --git a/tests/results/test_namespace/00_6secret.sh b/tests/results/test_namespace/00_6secret.sh new file mode 100644 index 0000000..3519305 --- /dev/null +++ b/tests/results/test_namespace/00_6secret.sh @@ -0,0 +1,16 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + +  Variable                           Description                       + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.secret1 + secret basic mandatory The first variable. + rougail.secret2 + secret standard mandatory The second variable. + Default: value + diff --git a/tests/results/test_namespace/04_5disabled_calculation_multi.adoc b/tests/results/test_namespace/04_5disabled_calculation_multi.adoc new file mode 100644 index 0000000..ec864c6 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_multi.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 conditional variable. + +**Default**: no +| + +**rougail.variable1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` `unique` `multiple` | +A first variable. + +**Disabled**: if condition is egal to "yes". +| + +**rougail.variable2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` `unique` `multiple` | +A second variable. + +**Disabled**: if condition is egal to "yes". +|==== + diff --git a/tests/results/test_namespace/04_5disabled_calculation_multi.json b/tests/results/test_namespace/04_5disabled_calculation_multi.json new file mode 100644 index 0000000..0158f28 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": "no", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.condition"], "names": ["condition"], "descriptions": ["A conditional variable."]}, "variable1": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is egal to \"yes\"."}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable1"], "names": ["variable1"], "descriptions": ["A first variable."], "multiple": true}, "variable2": {"type": "variable", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "basic"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "disabled", "annotation": "if condition is egal to \"yes\"."}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable2"], "names": ["variable2"], "descriptions": ["A second variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/04_5disabled_calculation_multi.md b/tests/results/test_namespace/04_5disabled_calculation_multi.md new file mode 100644 index 0000000..6120e31 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_multi.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`* `unique` `multiple` | 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`* `unique` `multiple` | A second variable.
**Disabled**: if condition is egal to "yes". | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_multi.sh b/tests/results/test_namespace/04_5disabled_calculation_multi.sh new file mode 100644 index 0000000..2005ca2 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_multi.sh @@ -0,0 +1,27 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + string standard mandatory A conditional variable. + Default: no + rougail.variable1 + string basic mandatory disabled A first variable. + unique multiple + Disabled: if condition is egal to + "yes". + rougail.variable2 + string basic mandatory disabled A second variable. + unique multiple + Disabled: if condition is egal to + "yes". + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable_multi.adoc b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.adoc new file mode 100644 index 0000000..9731505 --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.adoc @@ -0,0 +1,19 @@ +== Variables for "Rougail" + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.condition** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[boolean]` `standard` `mandatory` | +A condition. + +**Default**: false +| + +**rougail.variable** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `__disabled__` `unique` `multiple` | +A variable. + +**Disabled**: when the variable "rougail.condition" has the value "true". +|==== + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable_multi.json b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.json new file mode 100644 index 0000000..70b9e9f --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "basic"}]}, "children": {"condition": {"type": "variable", "default": false, "properties": [{"type": "type", "name": "boolean"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.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 \"rougail.condition\" has the value \"true\"."}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.variable"], "names": ["variable"], "descriptions": ["A variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable_multi.md b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.md new file mode 100644 index 0000000..cf4ebeb --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.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**: false | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* `unique` `multiple` | A variable.
**Disabled**: when the variable "rougail.condition" has the value "true". | + diff --git a/tests/results/test_namespace/04_5disabled_calculation_variable_multi.sh b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.sh new file mode 100644 index 0000000..eaa430d --- /dev/null +++ b/tests/results/test_namespace/04_5disabled_calculation_variable_multi.sh @@ -0,0 +1,21 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Variables for "Rougail" ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ + + + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.condition + boolean standard mandatory A condition. + Default: false + rougail.variable + string basic mandatory disabled A variable. + unique multiple + Disabled: when the variable + "rougail.condition" has the value + "true". + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.adoc new file mode 100644 index 0000000..c7a5127 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.json b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.json new file mode 100644 index 0000000..986e78e --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.md b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.md new file mode 100644 index 0000000..57b8ef1 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.sh new file mode 100644 index 0000000..a614be1 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-first.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory multiple A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.adoc new file mode 100644 index 0000000..c7a5127 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.json b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.json new file mode 100644 index 0000000..986e78e --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.md b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.md new file mode 100644 index 0000000..57b8ef1 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.sh new file mode 100644 index 0000000..a614be1 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower-last.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory multiple A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.adoc new file mode 100644 index 0000000..6ff3c76 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `multiple` | +A calculated variable. + +**Default**: the value of the variable "rougail.leader.follower1". +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower.json b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.json new file mode 100644 index 0000000..0812d47 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "the value of the variable \"rougail.leader.follower1\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower.md b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.md new file mode 100644 index 0000000..7242f6c --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: the value of the variable "rougail.leader.follower1". | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-follower.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.sh new file mode 100644 index 0000000..c82c7ef --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-follower.sh @@ -0,0 +1,40 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                                Description                           + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory multiple A calculated variable. + Default: the value of the variable + "rougail.leader.follower1". + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.adoc new file mode 100644 index 0000000..a93aa56 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.json b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.json new file mode 100644 index 0000000..7f08884 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.md b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.md new file mode 100644 index 0000000..8cb7d6a --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.sh new file mode 100644 index 0000000..4cf45c8 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-first.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.adoc new file mode 100644 index 0000000..a93aa56 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A calculated variable. + +**Default**: depends on a calculation. +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.json b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.json new file mode 100644 index 0000000..7f08884 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "depends on a calculation.", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."]}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.md b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.md new file mode 100644 index 0000000..8cb7d6a --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.sh new file mode 100644 index 0000000..4cf45c8 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader-last.sh @@ -0,0 +1,39 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory A calculated variable. + Default: depends on a calculation. + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader.adoc b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.adoc new file mode 100644 index 0000000..de2b1d3 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.adoc @@ -0,0 +1,45 @@ +== Variables for "Rougail" + +=== a leadership + +`standard` + +This family contains lists of variable blocks. + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.leader.leader** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A leader. + +**Default**: + +* value1 +* value2 +| + +**rougail.leader.follower1** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +A follower. + +**Default**: val11 +| + +**rougail.leader.follower2** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` | +An other follower. + +**Default**: val21 +|==== + +[cols="1a,1a"] +|==== +| Variable | Description +| + +**rougail.calculate** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `unique` `multiple` | +A calculated variable. + +**Default**: the value of the variable "rougail.leader.leader". +|==== + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader.json b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.json new file mode 100644 index 0000000..af7d700 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.json @@ -0,0 +1 @@ +{"rougail": {"type": "namespace", "informations": {"paths": ["rougail"], "names": ["rougail"], "description": "Rougail", "properties": [{"type": "mode", "name": "standard"}]}, "children": {"leader": {"type": "leadership", "informations": {"paths": ["rougail.leader"], "names": ["leader"], "description": "a leadership", "properties": [{"type": "mode", "name": "standard"}], "help": ["This family contains lists of variable blocks."]}, "children": {"leader": {"type": "variable", "default": ["value1", "value2"], "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.leader.leader"], "names": ["leader"], "descriptions": ["A leader."], "multiple": true}, "follower1": {"type": "variable", "default": "val11", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower1"], "names": ["follower1"], "descriptions": ["A follower."]}, "follower2": {"type": "variable", "default": "val21", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}], "paths": ["rougail.leader.follower2"], "names": ["follower2"], "descriptions": ["An other follower."]}}}, "calculate": {"type": "variable", "default": "the value of the variable \"rougail.leader.leader\".", "properties": [{"type": "type", "name": "string"}, {"type": "mode", "name": "standard"}, {"type": "property", "name": "mandatory"}, {"type": "property", "name": "unique"}, {"type": "multiple", "name": "multiple"}], "paths": ["rougail.calculate"], "names": ["calculate"], "descriptions": ["A calculated variable."], "multiple": true}}}} \ No newline at end of file diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader.md b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.md new file mode 100644 index 0000000..c149f20 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.md @@ -0,0 +1,22 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A calculated variable.
**Default**: the value of the variable "rougail.leader.leader". | + diff --git a/tests/results/test_namespace/40_9leadership-calculation-outside-leader.sh b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.sh new file mode 100644 index 0000000..859cde8 --- /dev/null +++ b/tests/results/test_namespace/40_9leadership-calculation-outside-leader.sh @@ -0,0 +1,41 @@ +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ 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: + + + • value1 + • value2 + | | rougail.leader.follower1 string standard mandatory + | A follower. Default: val11 + | | rougail.leader.follower2 string standard mandatory + | An other follower. Default: val21 + | + + + + +  Variable                               Description                            + ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + rougail.calculate + string standard mandatory unique A calculated variable. + multiple + Default: the value of the variable + "rougail.leader.leader". + diff --git a/tests/results/test_namespace_examples/00_6port.md b/tests/results/test_namespace_examples/00_6port.md index 2d700ba..8af52fc 100644 --- a/tests/results/test_namespace_examples/00_6port.md +++ b/tests/results/test_namespace_examples/00_6port.md @@ -6,9 +6,9 @@ include_toc: true | 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 | +| **rougail.variable1**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A port variable.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed | +| **rougail.variable2**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | +| **rougail.variable3**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A port variable with integer default value.
**Validators**:
- ports 1 to 1023 are allowed
- ports 1024 to 49151 are allowed
- ports greater than 49152 are allowed
**Default**: 8080 | # Example with mandatory variables not filled in diff --git a/tests/results/test_namespace_examples/00_6secret.md b/tests/results/test_namespace_examples/00_6secret.md new file mode 100644 index 0000000..de482b4 --- /dev/null +++ b/tests/results/test_namespace_examples/00_6secret.md @@ -0,0 +1,26 @@ +--- +gitea: none +include_toc: true +--- +# Variables for "Rougail" + +| Variable                                                                                                   | Description                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.secret1**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable. | +| **rougail.secret2**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The second variable.
**Default**: value | + +# Example with mandatory variables not filled in + +```yaml +--- +rougail: + secret1: secrets +``` +# Example with all variables modifiable + +```yaml +--- +rougail: + secret1: secrets + secret2: value +``` diff --git a/tests/results/test_namespace_examples/04_5disabled_calculation_multi.md b/tests/results/test_namespace_examples/04_5disabled_calculation_multi.md new file mode 100644 index 0000000..3b1d76b --- /dev/null +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_multi.md @@ -0,0 +1,33 @@ +--- +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`* `unique` `multiple` | 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`* `unique` `multiple` | 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/results/test_namespace_examples/04_5disabled_calculation_variable_multi.md b/tests/results/test_namespace_examples/04_5disabled_calculation_variable_multi.md new file mode 100644 index 0000000..1947144 --- /dev/null +++ b/tests/results/test_namespace_examples/04_5disabled_calculation_variable_multi.md @@ -0,0 +1,28 @@ +--- +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`* `unique` `multiple` | 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/40_9leadership-calculation-outside-follower-first.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-first.md new file mode 100644 index 0000000..ac3cb83 --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-first.md @@ -0,0 +1,37 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: + - val11 +``` diff --git a/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-last.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-last.md new file mode 100644 index 0000000..ac3cb83 --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower-last.md @@ -0,0 +1,37 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: + - val11 +``` diff --git a/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower.md new file mode 100644 index 0000000..c083c3b --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-follower.md @@ -0,0 +1,38 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `multiple` | A calculated variable.
**Default**: the value of the variable "rougail.leader.follower1". | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: + - val11 + - val11 +``` diff --git a/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-first.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-first.md new file mode 100644 index 0000000..8467851 --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-first.md @@ -0,0 +1,36 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: value1 +``` diff --git a/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-last.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-last.md new file mode 100644 index 0000000..d347341 --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader-last.md @@ -0,0 +1,36 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A calculated variable.
**Default**: depends on a calculation. | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: value2 +``` diff --git a/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader.md b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader.md new file mode 100644 index 0000000..a3b382c --- /dev/null +++ b/tests/results/test_namespace_examples/40_9leadership-calculation-outside-leader.md @@ -0,0 +1,38 @@ +--- +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**:
- value1
- value2 | +| **rougail.leader.follower1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A follower.
**Default**: val11 | +| **rougail.leader.follower2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | An other follower.
**Default**: val21 | + +| Variable                                                                                                                       | Description                                                                                                                    | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **rougail.calculate**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A calculated variable.
**Default**: the value of the variable "rougail.leader.leader". | + +# Example with all variables modifiable + +```yaml +--- +rougail: + leader: + - leader: value1 + follower1: val11 + follower2: val21 + - leader: value2 + follower1: val11 + follower2: val21 + calculate: + - value1 + - value2 +``` diff --git a/tests/test_force_optional.py b/tests/test_force_optional.py index e6594b1..7dfa09f 100644 --- a/tests/test_force_optional.py +++ b/tests/test_force_optional.py @@ -16,7 +16,7 @@ def test_force_optional(): rougail = Rougail(rougailconfig) config = rougail.run() inventory = RougailOutputDoc(config, rougailconfig=rougailconfig) - doc = inventory.run() + doc = inventory.run()[1] result_file = test_dir / 'force_optional.adoc' if not result_file.is_file(): with open(str(result_file), 'w') as docfh: diff --git a/tests/test_load.py b/tests/test_load.py index 0972607..0bcf0dd 100644 --- a/tests/test_load.py +++ b/tests/test_load.py @@ -53,7 +53,7 @@ def _test_dictionaries(test_dir, namespace, ext, *, examples=False): ################################## rougail = Rougail(rougailconfig) config = rougail.run() - generated_output = RougailOutput(config, rougailconfig=rougailconfig).run() + generated_output = RougailOutput(config, rougailconfig=rougailconfig).run()[1] 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(): diff --git a/tests/test_mode.py b/tests/test_mode.py index 4332844..1d98341 100644 --- a/tests/test_mode.py +++ b/tests/test_mode.py @@ -17,7 +17,7 @@ def _test(modes): rougail = Rougail(rougailconfig) config = rougail.run() inventory = RougailOutputDoc(config, rougailconfig=rougailconfig) - doc = inventory.run() + doc = inventory.run()[1] result_file = test_dir / f'mode_{"_".join(modes)}.adoc' if not result_file.is_file(): with open(str(result_file), 'w') as docfh: