diff --git a/pyproject.toml b/pyproject.toml index f49466e..e425b81 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,7 +25,7 @@ classifiers = [ ] dependencies = [ - "rougail ~= 1.1,<2", + "rougail ~= 1.2,<2", "tabulate ~= 0.9.0", ] diff --git a/src/rougail/output_doc/__init__.py b/src/rougail/output_doc/__init__.py index 1aa8e39..a6e7109 100644 --- a/src/rougail/output_doc/__init__.py +++ b/src/rougail/output_doc/__init__.py @@ -195,7 +195,7 @@ class RougailOutputDoc: return_string += self.formater.yaml(examples_mini) if examples_all: return_string += self.formater.title( - "Example with all variables modifiable", self.level + _("Example with all variables modifiable"), self.level ) return_string += self.formater.yaml(examples_all) return return_string @@ -376,13 +376,12 @@ class RougailOutputDoc: self.subparameter_to_parameter(subparameter, comment) if comment: msg += "\n".join(comment) + ENTER - help = self.to_phrase(family.information.get("help", "")) - if help: - msg += "\n" + help + ENTER + help_ = self.to_phrase(family.information.get("help", "")) + if help_: + msg += "\n" + help_ + ENTER if family.isleadership(): - # help = "Cette famille contient des listes de bloc de variables." - help = "This family contains lists of variable blocks." - msg += "\n" + help + ENTER + help_ = _("This family contains lists of variable blocks.") + msg += "\n" + help_ + ENTER if isdynamic: identifiers = family.identifiers(only_self=True, uncalculated=True) if isinstance(identifiers, Calculation): @@ -393,9 +392,10 @@ class RougailOutputDoc: continue identifiers[idx] = self.to_string(family, "dynamic", f"_{idx}") identifiers = self.formater.list(identifiers) - # help = f"Cette famille construit des familles dynamiquement.\n\n{self.formater.bold('Identifiers')}: {identifiers}" - help = f"This family builds families dynamically.\n\n{self.formater.bold('Identifiers')}: {identifiers}" - msg += "\n" + help + ENTER + help_ = _("This family builds families dynamically.\n\n{0}: {1}").format( + self.formater.bold("Identifiers"), identifiers + ) + msg += "\n" + help_ + ENTER return msg def manage_properties( @@ -406,15 +406,13 @@ class RougailOutputDoc: properties = variable.property.get(uncalculated=True) for mode in self.rougailconfig["modes_level"]: if mode in properties: - subparameter.append((self.formater.prop(mode), None, None)) + subparameter.append((mode, None, None, None)) break for prop, msg in self.property_to_string: if prop in properties: - subparameter.append((self.formater.prop(msg), None, None)) + subparameter.append((msg, None, None, None)) elif variable.information.get(f"{prop}_calculation", False): - subparameter.append( - (self.formater.prop(msg), msg, self.to_string(variable, prop)) - ) + subparameter.append((msg, msg, self.to_string(variable, prop), None)) def subparameter_to_string( self, @@ -422,10 +420,15 @@ class RougailOutputDoc: ): subparameter_str = "" for param in subparameter: - if param[1]: - subparameter_str += f"_{param[0]}_ " + if param[3]: + subparameter_str += self.formater.link(param[0], param[3]) + " " else: - subparameter_str += f"{param[0]} " + if param[1]: + italic = True + else: + italic = False + subparameter_str += self.formater.prop(param[0], italic) + " " + return subparameter_str[:-1] def subparameter_to_parameter( @@ -456,13 +459,13 @@ class RougailOutputDoc: if variable.isdynamic(): parameter = ["{{ ROUGAIL_PATH }}"] else: - parameter = [f"{self.formater.bold(variable.path())}"] - subparameter = [] + parameter = [self.formater.bold(variable.path())] description = variable.description(uncalculated=True) comment = [self.to_phrase(description)] help_ = self.to_phrase(variable.information.get("help", "")) if help_: - comment.append(help_) + comment.extend(help_.split("\n")) + subparameter = [] self.type_to_string( variable, subparameter, @@ -477,11 +480,14 @@ class RougailOutputDoc: else: multi = False if multi: - subparameter.append((self.formater.prop("multiple"), None, None)) + subparameter.append(("multiple", None, None, None)) if subparameter: parameter.append(self.subparameter_to_string(subparameter)) if variable.name() == description: - warning = f'No attribute "description" for variable "{variable.path()}" in {display_xmlfiles(variable.information.get("dictionaries"))}' + warning = _('No attribute "description" for variable "{0}" in {1}').format( + variable.path(), + display_xmlfiles(variable.information.get("dictionaries")), + ) warn(warning) default = self.get_default( variable, @@ -553,7 +559,9 @@ class RougailOutputDoc: raise Exception( f"cannot find {prop}_calculation_type{identifier} information, do you have declare doc has a plugins?" ) - if do_not_raise and variable.information.get(f"{prop}_calculation_optional{identifier}", False): + if do_not_raise and variable.information.get( + f"{prop}_calculation_optional{identifier}", False + ): return calculation = variable.information.get(f"{prop}_calculation{identifier}") if calculation_type == "jinja": @@ -561,7 +569,13 @@ class RougailOutputDoc: values = self.formater.to_string(calculation) else: values = _("depends on a calculation") - warning = _('"{0}" is a calculation for {1} but has no description in {2}').format(prop, variable.path(), display_xmlfiles(variable.information.get("dictionaries"))) + warning = _( + '"{0}" is a calculation for {1} but has no description in {2}' + ).format( + prop, + variable.path(), + display_xmlfiles(variable.information.get("dictionaries")), + ) warn(warning) elif calculation_type == "variable": if prop in PROPERTY_ATTRIBUTE: @@ -591,10 +605,10 @@ class RougailOutputDoc: doc_type = DocTypes.get(variable_type, {"params": {}}) subparameter.append( ( - self.formater.link( - doc_type.get("msg", variable_type), ROUGAIL_VARIABLE_TYPE - ), + doc_type.get("msg", variable_type), None, + None, + ROUGAIL_VARIABLE_TYPE, ) ) option = variable.get() @@ -621,11 +635,14 @@ class RougailOutputDoc: ) if validators: if len(validators) == 1: - comment.append(self.formater.bold(_("Validator")) + _(': ') + validators[0]) + comment.append( + self.formater.bold(_("Validator")) + _(": ") + validators[0] + ) else: comment.append( - self.formater.bold(_('Validators')) + _(': ') + - self.formater.list(validators) + self.formater.bold(_("Validators")) + + _(": ") + + self.formater.list(validators) ) def manage_exemples( @@ -647,7 +664,9 @@ class RougailOutputDoc: default = None if isinstance(example, tuple): example = list(example) - mandatory = "mandatory" in variable.property.get(uncalculated=True) + mandatory = "mandatory" in variable.property.get( + uncalculated=True + ) and not variable.value.get(uncalculated=True) if example: if not multi: example = example[0] diff --git a/src/rougail/output_doc/annotator.py b/src/rougail/output_doc/annotator.py index be55b65..c8d4f2a 100644 --- a/src/rougail/output_doc/annotator.py +++ b/src/rougail/output_doc/annotator.py @@ -217,11 +217,17 @@ class Annotator(Walk): ) if prop in PROPERTY_ATTRIBUTE: if values.when is not undefined: - values_calculation = _('when the variable "{0}" has the value "{1}"').format(values_calculation, values.when) + values_calculation = _( + 'when the variable "{0}" has the value "{1}"' + ).format(values_calculation, values.when) elif values.when_not is not undefined: - values_calculation = _('when the variable "{0}" hasn\'t the value "{1}"').format(values_calculation, values.when_not) + values_calculation = _( + 'when the variable "{0}" hasn\'t the value "{1}"' + ).format(values_calculation, values.when_not) else: - values_calculation = _('when the variable "{0}" has the value "True"').format(values_calculation) + values_calculation = _( + 'when the variable "{0}" has the value "True"' + ).format(values_calculation) values_calculation_type = "variable" if isinstance(values, VariableCalculation): values_optional = values.optional @@ -235,16 +241,22 @@ class Annotator(Walk): variable, path, ) - values_calculation = _('the value of the information "{0}" of the variable "{1}"').format(values.information, variable) + values_calculation = _( + 'the value of the information "{0}" of the variable "{1}"' + ).format(values.information, variable) else: - values_calculation = _('the value of the global information "{0}"').format(values.information) + values_calculation = _( + 'the value of the global information "{0}"' + ).format(values.information) elif isinstance(values, (IdentifierCalculation, IdentifierPropertyCalculation)): if version != "1.0" and prop in PROPERTY_ATTRIBUTE: if values.when is not undefined: - values_calculation = _('when the identifier is "{0}"').format(values.when) + values_calculation = _('when the identifier is "{0}"').format( + values.when + ) elif values.when_not is not undefined: - values_calculation = ( - _('when the identifier is not "{0}"').format(values.when_not) + values_calculation = _('when the identifier is not "{0}"').format( + values.when_not ) values_calculation_type = "identifier" elif isinstance(values, IndexCalculation): diff --git a/src/rougail/output_doc/i18n.py b/src/rougail/output_doc/i18n.py index fd6658f..af65524 100644 --- a/src/rougail/output_doc/i18n.py +++ b/src/rougail/output_doc/i18n.py @@ -19,6 +19,8 @@ along with this program. If not, see . from gettext import translation from pathlib import Path -t = translation("rougail_output_doc", str(Path(__file__).parent / "locale"), fallback=True) +t = translation( + "rougail_output_doc", str(Path(__file__).parent / "locale"), fallback=True +) _ = t.gettext diff --git a/src/rougail/output_doc/output/asciidoc.py b/src/rougail/output_doc/output/asciidoc.py index bd7b9c9..9ca9d0f 100644 --- a/src/rougail/output_doc/output/asciidoc.py +++ b/src/rougail/output_doc/output/asciidoc.py @@ -42,12 +42,12 @@ class Formater: return f"{char * (level + 1)} {title}\n\n" def yaml(self, dump: dict) -> str: - return f"[,yaml]\n----\n{self.dump(dump)}\n----\n" + return f"[,yaml]\n----\n---\n{self.dump(dump)}\n----\n" def table(self, table: str) -> str: # add 'a' option in cols to display list stable = table.split("\n", 1) - return stable[0].replace("<", "a") + "\n" + stable[1] + return '[cols="1a,1a"]\n' + stable[1] def link( self, @@ -59,7 +59,10 @@ class Formater: def prop( self, prop: str, + italic: bool, ) -> str: + if italic: + prop = self.italic(prop) return f"`{prop}`" def list( diff --git a/src/rougail/output_doc/output/github.py b/src/rougail/output_doc/output/github.py index 47fe0ab..00f0417 100644 --- a/src/rougail/output_doc/output/github.py +++ b/src/rougail/output_doc/output/github.py @@ -61,8 +61,12 @@ class Formater: def prop( self, prop: str, + italic: bool, ) -> str: - return f"`{prop}`" + prop = f"`{prop}`" + if italic: + prop = self.italic(prop) + return prop def list( self, diff --git a/tests/docs/base/00_0version_underscore.adoc b/tests/docs/base/00_0version_underscore.adoc index 2c18690..0a1a708 100644 --- a/tests/docs/base/00_0version_underscore.adoc +++ b/tests/docs/base/00_0version_underscore.adoc @@ -2,12 +2,13 @@ [,yaml] ---- +--- _version: '1.1' version: # a variable ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_1empty_variable.adoc b/tests/docs/base/00_1empty_variable.adoc index 26a947a..17cb2e2 100644 --- a/tests/docs/base/00_1empty_variable.adoc +++ b/tests/docs/base/00_1empty_variable.adoc @@ -2,12 +2,13 @@ [,yaml] ---- +--- version: '1.0' empty: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_2default_calculated.adoc b/tests/docs/base/00_2default_calculated.adoc index d24b194..6f64792 100644 --- a/tests/docs/base/00_2default_calculated.adoc +++ b/tests/docs/base/00_2default_calculated.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: no # a first variable var2: @@ -14,7 +15,7 @@ var2: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_2default_calculated_multi.adoc b/tests/docs/base/00_2default_calculated_multi.adoc index 01adeec..7daefd8 100644 --- a/tests/docs/base/00_2default_calculated_multi.adoc +++ b/tests/docs/base/00_2default_calculated_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: # a first variable - no @@ -19,7 +20,7 @@ var2: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_2default_calculated_variable_transitive.adoc b/tests/docs/base/00_2default_calculated_variable_transitive.adoc index 0893f37..e94a396 100644 --- a/tests/docs/base/00_2default_calculated_variable_transitive.adoc +++ b/tests/docs/base/00_2default_calculated_variable_transitive.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -19,7 +20,7 @@ var2: ---- == Variables for "rougail" -[cols="132a,132a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_4load_subfolder.adoc b/tests/docs/base/00_4load_subfolder.adoc index 93cc765..6227b94 100644 --- a/tests/docs/base/00_4load_subfolder.adoc +++ b/tests/docs/base/00_4load_subfolder.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var1: description: a variable @@ -10,13 +11,14 @@ var1: [,yaml] ---- +--- version: '1.0' var2: description: a variable ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_5load_notype.adoc b/tests/docs/base/00_5load_notype.adoc index fd473c5..adaed11 100644 --- a/tests/docs/base/00_5load_notype.adoc +++ b/tests/docs/base/00_5load_notype.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' without_type: description: a variable @@ -9,7 +10,7 @@ without_type: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6boolean.adoc b/tests/docs/base/00_6boolean.adoc index 0b27637..053105e 100644 --- a/tests/docs/base/00_6boolean.adoc +++ b/tests/docs/base/00_6boolean.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: true # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables for "rougail" -[cols="109a,109a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6boolean_no_mandatory.adoc b/tests/docs/base/00_6boolean_no_mandatory.adoc index a46bafb..b277a32 100644 --- a/tests/docs/base/00_6boolean_no_mandatory.adoc +++ b/tests/docs/base/00_6boolean_no_mandatory.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="97a,97a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6choice.adoc b/tests/docs/base/00_6choice.adoc index 41624e7..21d5ae3 100644 --- a/tests/docs/base/00_6choice.adoc +++ b/tests/docs/base/00_6choice.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: the first variable @@ -46,7 +47,7 @@ var6: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6choice_calculation.adoc b/tests/docs/base/00_6choice_calculation.adoc index 46a378f..c3c281c 100644 --- a/tests/docs/base/00_6choice_calculation.adoc +++ b/tests/docs/base/00_6choice_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6choice_variable.adoc b/tests/docs/base/00_6choice_variable.adoc index b1a91cb..7adbba6 100644 --- a/tests/docs/base/00_6choice_variable.adoc +++ b/tests/docs/base/00_6choice_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a second variable - a @@ -15,7 +16,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6custom.adoc b/tests/docs/base/00_6custom.adoc index 083cf3c..f9fe14b 100644 --- a/tests/docs/base/00_6custom.adoc +++ b/tests/docs/base/00_6custom.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' custom1: description: the first variable @@ -13,7 +14,7 @@ custom2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6domainname.adoc b/tests/docs/base/00_6domainname.adoc index d3c3dd7..561477a 100644 --- a/tests/docs/base/00_6domainname.adoc +++ b/tests/docs/base/00_6domainname.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a domain name variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="112a,112a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6domainname_params.adoc b/tests/docs/base/00_6domainname_params.adoc index 3ab5f80..6831946 100644 --- a/tests/docs/base/00_6domainname_params.adoc +++ b/tests/docs/base/00_6domainname_params.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a domain name variable @@ -12,7 +13,7 @@ variable: ---- == Variables for "rougail" -[cols="112a,112a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6float.adoc b/tests/docs/base/00_6float.adoc index f49c0b3..43b55c6 100644 --- a/tests/docs/base/00_6float.adoc +++ b/tests/docs/base/00_6float.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: 0.0 # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables for "rougail" -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6number.adoc b/tests/docs/base/00_6number.adoc index 2a32005..a59cf29 100644 --- a/tests/docs/base/00_6number.adoc +++ b/tests/docs/base/00_6number.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: 0 # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6port.adoc b/tests/docs/base/00_6port.adoc index 726cec0..dbed9ff 100644 --- a/tests/docs/base/00_6port.adoc +++ b/tests/docs/base/00_6port.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: description: a port variable @@ -17,7 +18,7 @@ variable3: ---- == Variables for "rougail" -[cols="106a,106a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6regexp.adoc b/tests/docs/base/00_6regexp.adoc index 12e5c8b..a96a914 100644 --- a/tests/docs/base/00_6regexp.adoc +++ b/tests/docs/base/00_6regexp.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a first variable @@ -13,7 +14,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_6string.adoc b/tests/docs/base/00_6string.adoc index d383846..63484b6 100644 --- a/tests/docs/base/00_6string.adoc +++ b/tests/docs/base/00_6string.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable var2: @@ -21,7 +22,7 @@ var6: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7choice_quote.adoc b/tests/docs/base/00_7choice_quote.adoc index 6066e7c..e9a1c5e 100644 --- a/tests/docs/base/00_7choice_quote.adoc +++ b/tests/docs/base/00_7choice_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: type: choice @@ -14,7 +15,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7help_quote.adoc b/tests/docs/base/00_7help_quote.adoc index d88d5b1..ff68e0d 100644 --- a/tests/docs/base/00_7help_quote.adoc +++ b/tests/docs/base/00_7help_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var1: description: the first variable @@ -12,7 +13,7 @@ var2: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7value_doublequote.adoc b/tests/docs/base/00_7value_doublequote.adoc index bfd6a69..6dfab6a 100644 --- a/tests/docs/base/00_7value_doublequote.adoc +++ b/tests/docs/base/00_7value_doublequote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7value_doublequote2.adoc b/tests/docs/base/00_7value_doublequote2.adoc index b7d6a7e..86d1e66 100644 --- a/tests/docs/base/00_7value_doublequote2.adoc +++ b/tests/docs/base/00_7value_doublequote2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7value_doublequote3.adoc b/tests/docs/base/00_7value_doublequote3.adoc index fb0f1bf..725dd44 100644 --- a/tests/docs/base/00_7value_doublequote3.adoc +++ b/tests/docs/base/00_7value_doublequote3.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_7value_quote.adoc b/tests/docs/base/00_7value_quote.adoc index dd25840..3d70bc6 100644 --- a/tests/docs/base/00_7value_quote.adoc +++ b/tests/docs/base/00_7value_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_8calculation_information.adoc b/tests/docs/base/00_8calculation_information.adoc index 7353c1a..7c881cf 100644 --- a/tests/docs/base/00_8calculation_information.adoc +++ b/tests/docs/base/00_8calculation_information.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -16,7 +17,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_8test.adoc b/tests/docs/base/00_8test.adoc index e1f5d9c..5369a7e 100644 --- a/tests/docs/base/00_8test.adoc +++ b/tests/docs/base/00_8test.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: @@ -44,7 +45,7 @@ var6: ---- == Variables for "rougail" -[cols="125a,125a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9choice_variable_multi.adoc b/tests/docs/base/00_9choice_variable_multi.adoc index 5182399..0d12d31 100644 --- a/tests/docs/base/00_9choice_variable_multi.adoc +++ b/tests/docs/base/00_9choice_variable_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: description: a first variable @@ -21,7 +22,7 @@ variable2: ---- == Variables for "rougail" -[cols="116a,116a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9choice_variables.adoc b/tests/docs/base/00_9choice_variables.adoc index d23dd95..8ed564d 100644 --- a/tests/docs/base/00_9choice_variables.adoc +++ b/tests/docs/base/00_9choice_variables.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' source_variable_1: val1 # the first source variable source_variable_2: val2 # the second source variable @@ -15,7 +16,7 @@ my_variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation.adoc b/tests/docs/base/00_9default_calculation.adoc index 8ff295d..b87632d 100644 --- a/tests/docs/base/00_9default_calculation.adoc +++ b/tests/docs/base/00_9default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: @@ -18,7 +19,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_information.adoc b/tests/docs/base/00_9default_calculation_information.adoc index 71510fd..56a5066 100644 --- a/tests/docs/base/00_9default_calculation_information.adoc +++ b/tests/docs/base/00_9default_calculation_information.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_information_other_variable.adoc b/tests/docs/base/00_9default_calculation_information_other_variable.adoc index 5d00ab5..a194a2f 100644 --- a/tests/docs/base/00_9default_calculation_information_other_variable.adoc +++ b/tests/docs/base/00_9default_calculation_information_other_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a first variable var2: @@ -17,7 +18,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_multi_optional.adoc b/tests/docs/base/00_9default_calculation_multi_optional.adoc index 2b0576b..cc18bce 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional.adoc +++ b/tests/docs/base/00_9default_calculation_multi_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: default: val1 @@ -15,7 +16,7 @@ my_calculated_variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_multi_optional2.adoc b/tests/docs/base/00_9default_calculation_multi_optional2.adoc index eab033a..92b9163 100644 --- a/tests/docs/base/00_9default_calculation_multi_optional2.adoc +++ b/tests/docs/base/00_9default_calculation_multi_optional2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: default: val1 @@ -15,7 +16,7 @@ my_calculated_variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_optional.adoc b/tests/docs/base/00_9default_calculation_optional.adoc index 53f392d..6033204 100644 --- a/tests/docs/base/00_9default_calculation_optional.adoc +++ b/tests/docs/base/00_9default_calculation_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_calculated_variable: multi: true @@ -11,7 +12,7 @@ my_calculated_variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_optional_exists.adoc b/tests/docs/base/00_9default_calculation_optional_exists.adoc index 0002ddf..31b8abe 100644 --- a/tests/docs/base/00_9default_calculation_optional_exists.adoc +++ b/tests/docs/base/00_9default_calculation_optional_exists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: multi: true @@ -16,7 +17,7 @@ my_calculated_variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_calculation_param_optional.adoc b/tests/docs/base/00_9default_calculation_param_optional.adoc index fdbb469..db094f0 100644 --- a/tests/docs/base/00_9default_calculation_param_optional.adoc +++ b/tests/docs/base/00_9default_calculation_param_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a first variable @@ -24,7 +25,7 @@ var2: no # a second variable ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_information_other_variable.adoc b/tests/docs/base/00_9default_information_other_variable.adoc index dbe82fd..3e5e091 100644 --- a/tests/docs/base/00_9default_information_other_variable.adoc +++ b/tests/docs/base/00_9default_information_other_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a first variable var2: @@ -13,7 +14,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9default_integer.adoc b/tests/docs/base/00_9default_integer.adoc index 6de9c23..cd37a80 100644 --- a/tests/docs/base/00_9default_integer.adoc +++ b/tests/docs/base/00_9default_integer.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9extra.adoc b/tests/docs/base/00_9extra.adoc index 06403ca..4be6094 100644 --- a/tests/docs/base/00_9extra.adoc +++ b/tests/docs/base/00_9extra.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: rougail # a variable ---- @@ -9,6 +10,7 @@ variable: rougail # a variable [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -18,7 +20,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -31,7 +33,7 @@ A variable. + == Variables for "extra" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/00_9extra_calculation.adoc b/tests/docs/base/00_9extra_calculation.adoc index e942e48..f23816a 100644 --- a/tests/docs/base/00_9extra_calculation.adoc +++ b/tests/docs/base/00_9extra_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: value # a variable ---- @@ -9,6 +10,7 @@ variable: value # a variable [,yaml] ---- +--- version: '1.1' variable1: description: a first variable @@ -32,7 +34,7 @@ variable3: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -45,7 +47,7 @@ A variable. + == Variables for "extra" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6boolean_multi.adoc b/tests/docs/base/01_6boolean_multi.adoc index 4f6a68a..b772566 100644 --- a/tests/docs/base/01_6boolean_multi.adoc +++ b/tests/docs/base/01_6boolean_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - true @@ -40,7 +41,7 @@ var8: ---- == Variables for "rougail" -[cols="129a,129a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6custom_multi.adoc b/tests/docs/base/01_6custom_multi.adoc index 43e5fee..c419e47 100644 --- a/tests/docs/base/01_6custom_multi.adoc +++ b/tests/docs/base/01_6custom_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' custom1: description: a first custom variable @@ -15,7 +16,7 @@ custom2: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6float_multi.adoc b/tests/docs/base/01_6float_multi.adoc index 212846a..68ff01d 100644 --- a/tests/docs/base/01_6float_multi.adoc +++ b/tests/docs/base/01_6float_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - 0.0 @@ -40,7 +41,7 @@ var8: ---- == Variables for "rougail" -[cols="127a,127a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6number_multi.adoc b/tests/docs/base/01_6number_multi.adoc index a5eb62a..d9ead7a 100644 --- a/tests/docs/base/01_6number_multi.adoc +++ b/tests/docs/base/01_6number_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - 0 @@ -40,7 +41,7 @@ var8: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6string_empty.adoc b/tests/docs/base/01_6string_empty.adoc index 06dfdbf..24a8f87 100644 --- a/tests/docs/base/01_6string_empty.adoc +++ b/tests/docs/base/01_6string_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: the second variable @@ -10,7 +11,7 @@ var1: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_6string_multi.adoc b/tests/docs/base/01_6string_multi.adoc index d95ac71..ed011bb 100644 --- a/tests/docs/base/01_6string_multi.adoc +++ b/tests/docs/base/01_6string_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: [] # the first variable var2: @@ -36,7 +37,7 @@ var8: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_7value_multi_doublequote.adoc b/tests/docs/base/01_7value_multi_doublequote.adoc index b52389c..b833ca7 100644 --- a/tests/docs/base/01_7value_multi_doublequote.adoc +++ b/tests/docs/base/01_7value_multi_doublequote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_7value_multi_doublequote2.adoc b/tests/docs/base/01_7value_multi_doublequote2.adoc index 13a6896..4043fe0 100644 --- a/tests/docs/base/01_7value_multi_doublequote2.adoc +++ b/tests/docs/base/01_7value_multi_doublequote2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_7value_multi_quote.adoc b/tests/docs/base/01_7value_multi_quote.adoc index c184046..8f3719c 100644 --- a/tests/docs/base/01_7value_multi_quote.adoc +++ b/tests/docs/base/01_7value_multi_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_8calculation_information_multi.adoc b/tests/docs/base/01_8calculation_information_multi.adoc index 1c44351..26730fe 100644 --- a/tests/docs/base/01_8calculation_information_multi.adoc +++ b/tests/docs/base/01_8calculation_information_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -17,7 +18,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/01_9choice_variable_multi.adoc b/tests/docs/base/01_9choice_variable_multi.adoc index f41ca51..442e5ad 100644 --- a/tests/docs/base/01_9choice_variable_multi.adoc +++ b/tests/docs/base/01_9choice_variable_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: # a first variable - a @@ -14,7 +15,7 @@ variable2: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_0type_param.adoc b/tests/docs/base/04_0type_param.adoc index 69eddf2..a8e7591 100644 --- a/tests/docs/base/04_0type_param.adoc +++ b/tests/docs/base/04_0type_param.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' int: description: A limited number @@ -12,7 +13,7 @@ int: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_1auto_save.adoc b/tests/docs/base/04_1auto_save.adoc index 604580b..f5acd71 100644 --- a/tests/docs/base/04_1auto_save.adoc +++ b/tests/docs/base/04_1auto_save.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 variable: description: an auto save variable @@ -10,7 +11,7 @@ variable: ---- == Variables for "rougail" -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_1auto_save_and_calculated.adoc b/tests/docs/base/04_1auto_save_and_calculated.adoc index 749d0c7..f73ed9c 100644 --- a/tests/docs/base/04_1auto_save_and_calculated.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: no # a first variable var2: @@ -12,7 +13,7 @@ var2: ---- == Variables for "rougail" -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc index a063ead..d864e79 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: @@ -19,7 +20,7 @@ var2: ---- == Variables for "rougail" -[cols="132a,132a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -29,7 +30,7 @@ A first variable. + **Default**: no | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` `auto modified` | A second variable. + **Default**: the value is always yes. + **Hidden**: only if the variable var1 has value "yes". diff --git a/tests/docs/base/04_1auto_save_and_calculated_hidden.md b/tests/docs/base/04_1auto_save_and_calculated_hidden.md index d17a171..be36b29 100644 --- a/tests/docs/base/04_1auto_save_and_calculated_hidden.md +++ b/tests/docs/base/04_1auto_save_and_calculated_hidden.md @@ -26,6 +26,6 @@ var2: | Variable                                                                                                                           | Description                                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`hidden`* `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | diff --git a/tests/docs/base/04_1auto_save_and_hidden.adoc b/tests/docs/base/04_1auto_save_and_hidden.adoc index 4dfe262..5fa72fd 100644 --- a/tests/docs/base/04_1auto_save_and_hidden.adoc +++ b/tests/docs/base/04_1auto_save_and_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: autosave variable diff --git a/tests/docs/base/04_1default_calculation_hidden.adoc b/tests/docs/base/04_1default_calculation_hidden.adoc index deb717e..44697c3 100644 --- a/tests/docs/base/04_1default_calculation_hidden.adoc +++ b/tests/docs/base/04_1default_calculation_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -24,7 +25,7 @@ var3: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -34,7 +35,7 @@ A first variable. + **Default**: value | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A second variable. + **Disabled**: when the variable "rougail.var1" has the value "value". | diff --git a/tests/docs/base/04_1default_calculation_hidden.md b/tests/docs/base/04_1default_calculation_hidden.md index 4e879b4..77f5254 100644 --- a/tests/docs/base/04_1default_calculation_hidden.md +++ b/tests/docs/base/04_1default_calculation_hidden.md @@ -31,7 +31,7 @@ var3: | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/base/04_1default_calculation_hidden_2.adoc b/tests/docs/base/04_1default_calculation_hidden_2.adoc index f42f260..77870b9 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.adoc +++ b/tests/docs/base/04_1default_calculation_hidden_2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -24,7 +25,7 @@ var3: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -34,7 +35,7 @@ A first variable. + **Default**: value | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A second variable. + **Disabled**: when the variable "rougail.var1" has the value "value". | diff --git a/tests/docs/base/04_1default_calculation_hidden_2.md b/tests/docs/base/04_1default_calculation_hidden_2.md index 23a1b90..c9d1de1 100644 --- a/tests/docs/base/04_1default_calculation_hidden_2.md +++ b/tests/docs/base/04_1default_calculation_hidden_2.md @@ -31,7 +31,7 @@ var3: | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "rougail.var1" has the value "value". | | **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/base/04_5disabled_calculation.adoc b/tests/docs/base/04_5disabled_calculation.adoc index 9406cc7..de59172 100644 --- a/tests/docs/base/04_5disabled_calculation.adoc +++ b/tests/docs/base/04_5disabled_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a conditional variable variable1: @@ -23,7 +24,7 @@ variable2: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -33,12 +34,12 @@ A conditional variable. + **Default**: no | **rougail.variable1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | 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`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A second variable. + **Disabled**: if condition is egal to "yes". |==== diff --git a/tests/docs/base/04_5disabled_calculation.md b/tests/docs/base/04_5disabled_calculation.md index 9f918bb..d84a553 100644 --- a/tests/docs/base/04_5disabled_calculation.md +++ b/tests/docs/base/04_5disabled_calculation.md @@ -30,7 +30,7 @@ variable2: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A conditional variable.
**Default**: no | -| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A first variable.
**Disabled**: if condition is egal to "yes". | -| **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: if condition is egal to "yes". | +| **rougail.variable1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A first variable.
**Disabled**: if condition is egal to "yes". | +| **rougail.variable2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: if condition is egal to "yes". | diff --git a/tests/docs/base/04_5disabled_calculation_default.adoc b/tests/docs/base/04_5disabled_calculation_default.adoc index f5df01e..6268c71 100644 --- a/tests/docs/base/04_5disabled_calculation_default.adoc +++ b/tests/docs/base/04_5disabled_calculation_default.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition @@ -34,7 +35,7 @@ var2: ---- == Variables for "rougail" -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -44,13 +45,13 @@ A condition. + **Default**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_disabled_` | A first variable. + **Default**: the value of condition. + **Disabled**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_disabled_` | A second variable. + **Default**: the value of condition. + **Disabled**: if condition is yes. diff --git a/tests/docs/base/04_5disabled_calculation_default.md b/tests/docs/base/04_5disabled_calculation_default.md index c0a977b..8f899f9 100644 --- a/tests/docs/base/04_5disabled_calculation_default.md +++ b/tests/docs/base/04_5disabled_calculation_default.md @@ -41,7 +41,7 @@ var2: | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A first variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A second variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A first variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A second variable.
**Default**: the value of condition.
**Disabled**: if condition is yes. | diff --git a/tests/docs/base/04_5disabled_calculation_optional.adoc b/tests/docs/base/04_5disabled_calculation_optional.adoc index cd48569..dcc3eca 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.adoc +++ b/tests/docs/base/04_5disabled_calculation_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var1: @@ -37,7 +38,7 @@ var2: ---- == Variables for "rougail" -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,12 +48,12 @@ A condition. + **Default**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_hidden_` | A first variable. + **Hidden**: calculation from an unknown variable. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_hidden_` | A second variable. + **Hidden**: calculation from an condition variable. |==== diff --git a/tests/docs/base/04_5disabled_calculation_optional.md b/tests/docs/base/04_5disabled_calculation_optional.md index 295351c..21056ac 100644 --- a/tests/docs/base/04_5disabled_calculation_optional.md +++ b/tests/docs/base/04_5disabled_calculation_optional.md @@ -44,7 +44,7 @@ var2: | Variable                                                                                                  | Description                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | diff --git a/tests/docs/base/04_5disabled_calculation_variable.adoc b/tests/docs/base/04_5disabled_calculation_variable.adoc index bf3ebd7..8c5a172 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: false # a condition variable: @@ -11,7 +12,7 @@ variable: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: False | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "rougail.condition" has the value "True". |==== diff --git a/tests/docs/base/04_5disabled_calculation_variable.md b/tests/docs/base/04_5disabled_calculation_variable.md index 596aea5..f332985 100644 --- a/tests/docs/base/04_5disabled_calculation_variable.md +++ b/tests/docs/base/04_5disabled_calculation_variable.md @@ -18,6 +18,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | diff --git a/tests/docs/base/04_5disabled_calculation_variable2.adoc b/tests/docs/base/04_5disabled_calculation_variable2.adoc index a10d35a..1d997ce 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # a condition variable: @@ -11,7 +12,7 @@ variable: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: True | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "rougail.condition" has the value "True". |==== diff --git a/tests/docs/base/04_5disabled_calculation_variable2.md b/tests/docs/base/04_5disabled_calculation_variable2.md index b7be4ea..b60897f 100644 --- a/tests/docs/base/04_5disabled_calculation_variable2.md +++ b/tests/docs/base/04_5disabled_calculation_variable2.md @@ -18,6 +18,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "True". | diff --git a/tests/docs/base/04_5disabled_calculation_variable3.adoc b/tests/docs/base/04_5disabled_calculation_variable3.adoc index 293bd22..6baf57b 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable3.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition variable: @@ -12,7 +13,7 @@ variable: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -22,7 +23,7 @@ A condition. + **Default**: yes | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "rougail.condition" has the value "yes". |==== diff --git a/tests/docs/base/04_5disabled_calculation_variable3.md b/tests/docs/base/04_5disabled_calculation_variable3.md index 898882f..7482828 100644 --- a/tests/docs/base/04_5disabled_calculation_variable3.md +++ b/tests/docs/base/04_5disabled_calculation_variable3.md @@ -19,6 +19,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" has the value "yes". | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" has the value "yes". | diff --git a/tests/docs/base/04_5disabled_calculation_variable4.adoc b/tests/docs/base/04_5disabled_calculation_variable4.adoc index eb14054..103d5ae 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/base/04_5disabled_calculation_variable4.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition variable: @@ -12,7 +13,7 @@ variable: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -22,7 +23,7 @@ A condition. + **Default**: yes | **rougail.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "rougail.condition" hasn't the value "yes". |==== diff --git a/tests/docs/base/04_5disabled_calculation_variable4.md b/tests/docs/base/04_5disabled_calculation_variable4.md index cb62409..abd909a 100644 --- a/tests/docs/base/04_5disabled_calculation_variable4.md +++ b/tests/docs/base/04_5disabled_calculation_variable4.md @@ -19,6 +19,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "rougail.condition" hasn't the value "yes". | +| **rougail.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "rougail.condition" hasn't the value "yes". | diff --git a/tests/docs/base/04_5hidden_calculation.adoc b/tests/docs/base/04_5hidden_calculation.adoc index 6d27f50..40bfd90 100644 --- a/tests/docs/base/04_5hidden_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the condition var1: @@ -25,7 +26,7 @@ var2: ---- == Variables for "rougail" -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -35,13 +36,13 @@ The condition. + **Default**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A first variable. + **Default**: no + **Hidden**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A second variable. + **Default**: no + **Hidden**: if condition is yes. diff --git a/tests/docs/base/04_5hidden_calculation.md b/tests/docs/base/04_5hidden_calculation.md index 818d070..6574af4 100644 --- a/tests/docs/base/04_5hidden_calculation.md +++ b/tests/docs/base/04_5hidden_calculation.md @@ -32,7 +32,7 @@ var2: | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | The condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: no
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: no
**Hidden**: if condition is yes. | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: no
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: no
**Hidden**: if condition is yes. | diff --git a/tests/docs/base/04_5hidden_calculation2.adoc b/tests/docs/base/04_5hidden_calculation2.adoc index 7196e24..b8d0944 100644 --- a/tests/docs/base/04_5hidden_calculation2.adoc +++ b/tests/docs/base/04_5hidden_calculation2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var1: @@ -31,7 +32,7 @@ var2: ---- == Variables for "rougail" -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -41,13 +42,13 @@ A condition. + **Default**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A first variable. + **Default**: the value of condition. + **Hidden**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A second variable. + **Default**: the value of condition. + **Hidden**: if condition is yes. diff --git a/tests/docs/base/04_5hidden_calculation2.md b/tests/docs/base/04_5hidden_calculation2.md index 9e85001..a2acce2 100644 --- a/tests/docs/base/04_5hidden_calculation2.md +++ b/tests/docs/base/04_5hidden_calculation2.md @@ -38,7 +38,7 @@ var2: | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: the value of condition.
**Hidden**: if condition is yes. | diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc index 0ddd60e..f5f3652 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.adoc +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var1: @@ -31,7 +32,7 @@ var2: ---- == Variables for "rougail" -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -41,13 +42,13 @@ A condition. + **Default**: no | **rougail.var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A first variable. + **Default**: returns the condition value. + **Hidden**: if condition is yes. | **rougail.var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_hidden_` | A second variable. + **Default**: returns the condition value. + **Hidden**: if condition is yes. diff --git a/tests/docs/base/04_5hidden_calculation_default_calculation.md b/tests/docs/base/04_5hidden_calculation_default_calculation.md index 38ee76b..70838aa 100644 --- a/tests/docs/base/04_5hidden_calculation_default_calculation.md +++ b/tests/docs/base/04_5hidden_calculation_default_calculation.md @@ -38,7 +38,7 @@ var2: | Variable                                                                                                              | Description                                                                                                           | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A first variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`hidden`_ | A second variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A first variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`hidden`* | A second variable.
**Default**: returns the condition value.
**Hidden**: if condition is yes. | diff --git a/tests/docs/base/04_5validators.adoc b/tests/docs/base/04_5validators.adoc index dfcdd4a..0832f47 100644 --- a/tests/docs/base/04_5validators.adoc +++ b/tests/docs/base/04_5validators.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' int: description: A number @@ -15,7 +16,7 @@ int: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_5validators_differ.adoc b/tests/docs/base/04_5validators_differ.adoc index b8c4636..c4cbb35 100644 --- a/tests/docs/base/04_5validators_differ.adoc +++ b/tests/docs/base/04_5validators_differ.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a first variable @@ -19,7 +20,7 @@ var2: no # A second variable ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_5validators_in_network.adoc b/tests/docs/base/04_5validators_in_network.adoc deleted file mode 100644 index 0f1428e..0000000 --- a/tests/docs/base/04_5validators_in_network.adoc +++ /dev/null @@ -1,64 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Network address - type: netmask -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} - {% endif %} - description: check if IP in the previous network ----- -== Variables for "rougail" - -[cols="101a,101a",options="header"] -|==== -| Variable | Description -| -**rougail.network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | -Network address. -| -**rougail.netmask_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | -Network address. -| -**rougail.ip_address** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | -An IP. + -**Validators**: - -* reserved IP are allowed -* check if IP in the previous network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 - ip_address: 1.1.1.1 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 - ip_address: 1.1.1.1 ----- diff --git a/tests/docs/base/04_5validators_in_network.md b/tests/docs/base/04_5validators_in_network.md deleted file mode 100644 index 8851b62..0000000 --- a/tests/docs/base/04_5validators_in_network.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Network address - type: netmask -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} - {% endif %} - description: check if IP in the previous network -``` -# Variables for "rougail" - -| Variable                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **rougail.netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **rougail.ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- check if IP in the previous network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 - ip_address: 1.1.1.1 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 - ip_address: 1.1.1.1 -``` diff --git a/tests/docs/base/04_5validators_in_network_cidr.adoc b/tests/docs/base/04_5validators_in_network_cidr.adoc deleted file mode 100644 index 613b470..0000000 --- a/tests/docs/base/04_5validators_in_network_cidr.adoc +++ /dev/null @@ -1,55 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: cidr -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} - {% endif %} - description: this IP must be in network ----- -== Variables for "rougail" - -[cols="101a,101a",options="header"] -|==== -| Variable | Description -| -**rougail.network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[cidr]` `basic` `mandatory` | -Network address. -| -**rougail.ip_address** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | -An IP. + -**Validators**: - -* reserved IP are allowed -* this IP must be in network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0/24 - ip_address: 1.1.1.1 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0/24 - ip_address: 1.1.1.1 ----- diff --git a/tests/docs/base/04_5validators_in_network_cidr.md b/tests/docs/base/04_5validators_in_network_cidr.md deleted file mode 100644 index 66b0859..0000000 --- a/tests/docs/base/04_5validators_in_network_cidr.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: cidr -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} - {% endif %} - description: this IP must be in network -``` -# Variables for "rougail" - -| Variable                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.network_address_eth0**
[`cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **rougail.ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- this IP must be in network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0/24 - ip_address: 1.1.1.1 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0/24 - ip_address: 1.1.1.1 -``` diff --git a/tests/docs/base/04_5validators_ipnetmask.adoc b/tests/docs/base/04_5validators_ipnetmask.adoc deleted file mode 100644 index fd3b10e..0000000 --- a/tests/docs/base/04_5validators_ipnetmask.adoc +++ /dev/null @@ -1,52 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Netmask address - type: netmask - validators: - - type: jinja - jinja: | - {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} - {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} - {% endif %} - description: this mask is possible for the network ----- -== Variables for "rougail" - -[cols="106a,106a",options="header"] -|==== -| Variable | Description -| -**rougail.network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | -Network address. -| -**rougail.netmask_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | -Netmask address. + -**Validator**: this mask is possible for the network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 ----- -== Example with all variables modifiable - -[,yaml] ----- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 ----- diff --git a/tests/docs/base/04_5validators_ipnetmask.md b/tests/docs/base/04_5validators_ipnetmask.md deleted file mode 100644 index 65384f2..0000000 --- a/tests/docs/base/04_5validators_ipnetmask.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Netmask address - type: netmask - validators: - - type: jinja - jinja: | - {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} - {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} - {% endif %} - description: this mask is possible for the network -``` -# Variables for "rougail" - -| Variable                                                                                                 | Description                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **rougail.netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Netmask address.
**Validator**: this mask is possible for the network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 -``` -# Example with all variables modifiable - -```yaml ---- -rougail: - network_address_eth0: 1.1.1.0 - netmask_address_eth0: 255.255.255.0 -``` diff --git a/tests/docs/base/04_5validators_multi.adoc b/tests/docs/base/04_5validators_multi.adoc index fea1617..d8cb9d5 100644 --- a/tests/docs/base/04_5validators_multi.adoc +++ b/tests/docs/base/04_5validators_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: description: a second variable @@ -18,7 +19,7 @@ var1: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_5validators_multi2.adoc b/tests/docs/base/04_5validators_multi2.adoc index 8c39199..5bffa31 100644 --- a/tests/docs/base/04_5validators_multi2.adoc +++ b/tests/docs/base/04_5validators_multi2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: description: a second variable @@ -25,7 +26,7 @@ var1: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/04_7validators_variable_optional.adoc b/tests/docs/base/04_7validators_variable_optional.adoc index afcc9bb..c8e465b 100644 --- a/tests/docs/base/04_7validators_variable_optional.adoc +++ b/tests/docs/base/04_7validators_variable_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' general: # a family int: @@ -36,7 +37,7 @@ general: # a family `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/05_0multi_not_uniq.adoc b/tests/docs/base/05_0multi_not_uniq.adoc index 836ca87..99ecff1 100644 --- a/tests/docs/base/05_0multi_not_uniq.adoc +++ b/tests/docs/base/05_0multi_not_uniq.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a variable @@ -11,7 +12,7 @@ var1: ---- == Variables for "rougail" -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/05_0multi_uniq.adoc b/tests/docs/base/05_0multi_uniq.adoc index 9ddc7c7..498c9d9 100644 --- a/tests/docs/base/05_0multi_uniq.adoc +++ b/tests/docs/base/05_0multi_uniq.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,7 +12,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/12_1auto_save_expert.adoc b/tests/docs/base/12_1auto_save_expert.adoc index b2fa8f9..82f7a9f 100644 --- a/tests/docs/base/12_1auto_save_expert.adoc +++ b/tests/docs/base/12_1auto_save_expert.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var: description: a variable diff --git a/tests/docs/base/16_0redefine_description.adoc b/tests/docs/base/16_0redefine_description.adoc index 3a2c1d4..1290f2f 100644 --- a/tests/docs/base/16_0redefine_description.adoc +++ b/tests/docs/base/16_0redefine_description.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: Redefine description @@ -10,6 +11,7 @@ var: [,yaml] ---- +--- version: '1.1' var: description: Redefined @@ -17,7 +19,7 @@ var: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_2family_redefine_calculation.adoc b/tests/docs/base/16_2family_redefine_calculation.adoc index e2d32dd..c413e97 100644 --- a/tests/docs/base/16_2family_redefine_calculation.adoc +++ b/tests/docs/base/16_2family_redefine_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' family: redefine: true @@ -13,6 +14,7 @@ family: [,yaml] ---- +--- version: '1.0' family: var1: @@ -21,11 +23,11 @@ family: === rougail.family -`basic` _`disabled`_ +`basic` `_disabled_` **Disabled**: depends on a calculation. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_2family_redefine_calculation.md b/tests/docs/base/16_2family_redefine_calculation.md index 4838b32..febf473 100644 --- a/tests/docs/base/16_2family_redefine_calculation.md +++ b/tests/docs/base/16_2family_redefine_calculation.md @@ -25,7 +25,7 @@ family: ## rougail.family -`basic` _`disabled`_ +`basic` *`disabled`* **Disabled**: depends on a calculation. diff --git a/tests/docs/base/16_2family_redefine_disabled.adoc b/tests/docs/base/16_2family_redefine_disabled.adoc index 14f798a..4b2cf1e 100644 --- a/tests/docs/base/16_2family_redefine_disabled.adoc +++ b/tests/docs/base/16_2family_redefine_disabled.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.0' family: var1: diff --git a/tests/docs/base/16_5exists_nonexists.adoc b/tests/docs/base/16_5exists_nonexists.adoc index 8575c72..56d0ea3 100644 --- a/tests/docs/base/16_5exists_nonexists.adoc +++ b/tests/docs/base/16_5exists_nonexists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var2: description: a new variable @@ -12,12 +13,13 @@ var2: [,yaml] ---- +--- version: '1.1' var1: no # a variable ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5exists_redefine.adoc b/tests/docs/base/16_5exists_redefine.adoc index ffd4c3d..3a8a3a3 100644 --- a/tests/docs/base/16_5exists_redefine.adoc +++ b/tests/docs/base/16_5exists_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: redefine: true @@ -17,6 +18,7 @@ var2: [,yaml] ---- +--- version: '1.1' var1: description: a first variable diff --git a/tests/docs/base/16_5redefine_calculation.adoc b/tests/docs/base/16_5redefine_calculation.adoc index 1dff24a..9d2de81 100644 --- a/tests/docs/base/16_5redefine_calculation.adoc +++ b/tests/docs/base/16_5redefine_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -13,6 +14,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -22,7 +24,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_choice.adoc b/tests/docs/base/16_5redefine_choice.adoc index 3d582f2..79e4864 100644 --- a/tests/docs/base/16_5redefine_choice.adoc +++ b/tests/docs/base/16_5redefine_choice.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -14,6 +15,7 @@ variable: [,yaml] ---- +--- version: '1.0' variable: redefine: true @@ -23,7 +25,7 @@ variable: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_default.adoc b/tests/docs/base/16_5redefine_default.adoc index fb09c6d..ab7296a 100644 --- a/tests/docs/base/16_5redefine_default.adoc +++ b/tests/docs/base/16_5redefine_default.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -18,7 +20,7 @@ variable: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_default_calculation.adoc b/tests/docs/base/16_5redefine_default_calculation.adoc index eabec8d..beeff35 100644 --- a/tests/docs/base/16_5redefine_default_calculation.adoc +++ b/tests/docs/base/16_5redefine_default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -19,7 +21,7 @@ variable: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_family.adoc b/tests/docs/base/16_5redefine_family.adoc index d34ecea..18ba3d7 100644 --- a/tests/docs/base/16_5redefine_family.adoc +++ b/tests/docs/base/16_5redefine_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: # a family variable: # a variable @@ -21,7 +23,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_help.adoc b/tests/docs/base/16_5redefine_help.adoc index ee0daa1..eedb5f4 100644 --- a/tests/docs/base/16_5redefine_help.adoc +++ b/tests/docs/base/16_5redefine_help.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -14,6 +15,7 @@ family: [,yaml] ---- +--- version: '1.1' family: description: a family @@ -31,7 +33,7 @@ family: Redefine help family ok. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_hidden.adoc b/tests/docs/base/16_5redefine_hidden.adoc index e6861a6..cb09425 100644 --- a/tests/docs/base/16_5redefine_hidden.adoc +++ b/tests/docs/base/16_5redefine_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: no # a variable ---- @@ -9,6 +10,7 @@ variable: no # a variable [,yaml] ---- +--- version: '1.1' variable: redefine: true diff --git a/tests/docs/base/16_5redefine_multi.adoc b/tests/docs/base/16_5redefine_multi.adoc index 4e83baf..b95375f 100644 --- a/tests/docs/base/16_5redefine_multi.adoc +++ b/tests/docs/base/16_5redefine_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -20,7 +22,7 @@ variable: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc index 687f1aa..6fbecdb 100644 --- a/tests/docs/base/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/base/16_5redefine_remove_disable_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' condition: no # a condition variable: @@ -25,7 +27,7 @@ variable: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_5test_redefine.adoc b/tests/docs/base/16_5test_redefine.adoc index fa176f5..066f8ff 100644 --- a/tests/docs/base/16_5test_redefine.adoc +++ b/tests/docs/base/16_5test_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: @@ -18,6 +19,7 @@ var3: [,yaml] ---- +--- version: '1.1' var1: redefine: true @@ -33,7 +35,7 @@ var3: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16_6choice_redefine.adoc b/tests/docs/base/16_6choice_redefine.adoc index dc79b9a..dd125f6 100644 --- a/tests/docs/base/16_6choice_redefine.adoc +++ b/tests/docs/base/16_6choice_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: redefine: true @@ -13,6 +14,7 @@ var: [,yaml] ---- +--- version: '1.0' var: type: choice @@ -25,7 +27,7 @@ var: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/16exists_exists.adoc b/tests/docs/base/16exists_exists.adoc index fc73525..7810ff0 100644 --- a/tests/docs/base/16exists_exists.adoc +++ b/tests/docs/base/16exists_exists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: New description @@ -11,13 +12,14 @@ var: [,yaml] ---- +--- version: '1.1' var: description: Description ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/17_5redefine_leadership.adoc b/tests/docs/base/17_5redefine_leadership.adoc index 8b41cc5..a02b2bb 100644 --- a/tests/docs/base/17_5redefine_leadership.adoc +++ b/tests/docs/base/17_5redefine_leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: redefine: true @@ -11,6 +12,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: # a leadership type: leadership diff --git a/tests/docs/base/20_0empty_family.adoc b/tests/docs/base/20_0empty_family.adoc index 2bf432c..8ae6bd6 100644 --- a/tests/docs/base/20_0empty_family.adoc +++ b/tests/docs/base/20_0empty_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' my_family: type: family diff --git a/tests/docs/base/20_0family_append.adoc b/tests/docs/base/20_0family_append.adoc index 223e38a..f2aa74a 100644 --- a/tests/docs/base/20_0family_append.adoc +++ b/tests/docs/base/20_0family_append.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: var2: @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: description: A family @@ -23,7 +25,7 @@ family: `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/20_0family_underscore.adoc b/tests/docs/base/20_0family_underscore.adoc index e18f2fd..1233c95 100644 --- a/tests/docs/base/20_0family_underscore.adoc +++ b/tests/docs/base/20_0family_underscore.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' my_family: _type: family diff --git a/tests/docs/base/20_0multi_family.adoc b/tests/docs/base/20_0multi_family.adoc index 977c580..bc1af3e 100644 --- a/tests/docs/base/20_0multi_family.adoc +++ b/tests/docs/base/20_0multi_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family subfamily: # a sub family @@ -19,7 +20,7 @@ family: # a family `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/20_0multi_family_basic.adoc b/tests/docs/base/20_0multi_family_basic.adoc index a141173..83693d2 100644 --- a/tests/docs/base/20_0multi_family_basic.adoc +++ b/tests/docs/base/20_0multi_family_basic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family subfamily: # a sub family @@ -17,7 +18,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/20_0multi_family_expert.adoc b/tests/docs/base/20_0multi_family_expert.adoc index b5495aa..63dadfe 100644 --- a/tests/docs/base/20_0multi_family_expert.adoc +++ b/tests/docs/base/20_0multi_family_expert.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: description: a family diff --git a/tests/docs/base/20_0multi_family_order.adoc b/tests/docs/base/20_0multi_family_order.adoc index d0d749e..0520952 100644 --- a/tests/docs/base/20_0multi_family_order.adoc +++ b/tests/docs/base/20_0multi_family_order.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: # a variable family: # a family @@ -12,7 +13,7 @@ family: # a family ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -25,7 +26,7 @@ A variable. `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ A first variable. `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ A first variable. A variable. |==== -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/20_0validators_differ_redefine.adoc b/tests/docs/base/20_0validators_differ_redefine.adoc index e4ccdc5..81023b0 100644 --- a/tests/docs/base/20_0validators_differ_redefine.adoc +++ b/tests/docs/base/20_0validators_differ_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var3: redefine: true @@ -16,6 +17,7 @@ var3: [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: no # a second variable @@ -33,7 +35,7 @@ var3: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/20_1empty_subfamily.adoc b/tests/docs/base/20_1empty_subfamily.adoc index a830ac2..2697f74 100644 --- a/tests/docs/base/20_1empty_subfamily.adoc +++ b/tests/docs/base/20_1empty_subfamily.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' my_family: my_sub_family: diff --git a/tests/docs/base/20_9default_information_parent.adoc b/tests/docs/base/20_9default_information_parent.adoc index 0ebfafb..0e388a5 100644 --- a/tests/docs/base/20_9default_information_parent.adoc +++ b/tests/docs/base/20_9default_information_parent.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 family: var1: # a first variable @@ -18,7 +19,7 @@ family: `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_condition.adoc b/tests/docs/base/24_0family_hidden_condition.adoc index 9655f29..3d7a852 100644 --- a/tests/docs/base/24_0family_hidden_condition.adoc +++ b/tests/docs/base/24_0family_hidden_condition.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the variable use has condition family: @@ -16,7 +17,7 @@ family: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -28,11 +29,11 @@ The variable use has condition. + === possibly hidden family -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is yes. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_condition.md b/tests/docs/base/24_0family_hidden_condition.md index ad0bbdc..e724b29 100644 --- a/tests/docs/base/24_0family_hidden_condition.md +++ b/tests/docs/base/24_0family_hidden_condition.md @@ -26,7 +26,7 @@ family: ## possibly hidden family -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is yes. diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.adoc b/tests/docs/base/24_0family_hidden_condition_boolean.adoc index 07ab4e4..8166d5c 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.adoc +++ b/tests/docs/base/24_0family_hidden_condition_boolean.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: false # a conditional variable family: @@ -18,7 +19,7 @@ family: ---- == Variables for "rougail" -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -30,11 +31,11 @@ A conditional variable. + === a family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: if not condition. -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_condition_boolean.md b/tests/docs/base/24_0family_hidden_condition_boolean.md index 8567a08..b0975d9 100644 --- a/tests/docs/base/24_0family_hidden_condition_boolean.md +++ b/tests/docs/base/24_0family_hidden_condition_boolean.md @@ -28,7 +28,7 @@ family: ## a family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: if not condition. diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc index 3896931..66cf57e 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the variable use has condition family: @@ -17,7 +18,7 @@ family: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -29,7 +30,7 @@ The variable use has condition. + === possibly hidden family -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is yes. @@ -37,7 +38,7 @@ The variable use has condition. + `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_condition_sub_family.md b/tests/docs/base/24_0family_hidden_condition_sub_family.md index 233b5c1..0989e2b 100644 --- a/tests/docs/base/24_0family_hidden_condition_sub_family.md +++ b/tests/docs/base/24_0family_hidden_condition_sub_family.md @@ -27,7 +27,7 @@ family: ## possibly hidden family -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is yes. diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc index 3ad506f..a472899 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # the variable use has condition family: @@ -15,7 +16,7 @@ family: ---- == Variables for "rougail" -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -27,7 +28,7 @@ The variable use has condition. + === possibly hidden family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: when the variable "rougail.condition" has the value "True". @@ -35,7 +36,7 @@ The variable use has condition. + `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md index cc969a0..81d25c2 100644 --- a/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md +++ b/tests/docs/base/24_0family_hidden_condition_variable_sub_family.md @@ -25,7 +25,7 @@ family: ## possibly hidden family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: when the variable "rougail.condition" has the value "True". diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc index a808dba..9df02a6 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.adoc +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition1: false # a first conditional variable condition2: false # a second conditional variable @@ -25,7 +26,7 @@ family: ---- == Variables for "rougail" -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,16 +43,16 @@ A second conditional variable. + === a family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: if condition1 is false. -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | **rougail.family.variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_hidden_` | A variable. + **Hidden**: if condition2 is false. |==== diff --git a/tests/docs/base/24_0family_hidden_condition_with_variable.md b/tests/docs/base/24_0family_hidden_condition_with_variable.md index 3b01a64..8e199bb 100644 --- a/tests/docs/base/24_0family_hidden_condition_with_variable.md +++ b/tests/docs/base/24_0family_hidden_condition_with_variable.md @@ -36,12 +36,12 @@ family: ## a family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: if condition1 is false. | Variable                                                                                                  | Description                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`hidden`_ | A variable.
**Hidden**: if condition2 is false. | +| **rougail.family.variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A variable.
**Hidden**: if condition2 is false. | diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc index 159850c..fef98e2 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the variable use has condition family: @@ -20,7 +21,7 @@ family: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -32,7 +33,7 @@ The variable use has condition. + === possibly hidden family -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is yes. @@ -40,7 +41,7 @@ The variable use has condition. + `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md index c5370cc..b9f0b6b 100644 --- a/tests/docs/base/24_0family_hidden_param_condition_sub_family.md +++ b/tests/docs/base/24_0family_hidden_param_condition_sub_family.md @@ -30,7 +30,7 @@ family: ## possibly hidden family -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is yes. diff --git a/tests/docs/base/24_0family_mandatory_condition.adoc b/tests/docs/base/24_0family_mandatory_condition.adoc index efa807e..84b8d8f 100644 --- a/tests/docs/base/24_0family_mandatory_condition.adoc +++ b/tests/docs/base/24_0family_mandatory_condition.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var: @@ -15,7 +16,7 @@ var: ---- == Variables for "rougail" -[cols="110a,110a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -25,7 +26,7 @@ A condition. + **Default**: no | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_mandatory_` | A variable. + **Mandatory**: only if rougail.condition has the value "yes". |==== diff --git a/tests/docs/base/24_0family_mandatory_condition.md b/tests/docs/base/24_0family_mandatory_condition.md index f602e53..f22ee2d 100644 --- a/tests/docs/base/24_0family_mandatory_condition.md +++ b/tests/docs/base/24_0family_mandatory_condition.md @@ -22,6 +22,6 @@ var: | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.adoc b/tests/docs/base/24_0family_mandatory_condition_variable.adoc index d78208b..3bcf1bb 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/base/24_0family_mandatory_condition_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # a condition var: @@ -11,7 +12,7 @@ var: ---- == Variables for "rougail" -[cols="110a,110a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: True | **rougail.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_mandatory_` | A variable. + **Mandatory**: when the variable "rougail.condition" has the value "True". |==== diff --git a/tests/docs/base/24_0family_mandatory_condition_variable.md b/tests/docs/base/24_0family_mandatory_condition_variable.md index 7ad01aa..94b758f 100644 --- a/tests/docs/base/24_0family_mandatory_condition_variable.md +++ b/tests/docs/base/24_0family_mandatory_condition_variable.md @@ -18,6 +18,6 @@ var: | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: when the variable "rougail.condition" has the value "True". | +| **rougail.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: when the variable "rougail.condition" has the value "True". | diff --git a/tests/docs/base/24_family_disabled_var_hidden.adoc b/tests/docs/base/24_family_disabled_var_hidden.adoc index fc4f78b..2b8fd13 100644 --- a/tests/docs/base/24_family_disabled_var_hidden.adoc +++ b/tests/docs/base/24_family_disabled_var_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 family: diff --git a/tests/docs/base/40_0leadership.adoc b/tests/docs/base/40_0leadership.adoc index 1d381d8..a1521b8 100644 --- a/tests/docs/base/40_0leadership.adoc +++ b/tests/docs/base/40_0leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -19,7 +20,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_diff_name.adoc b/tests/docs/base/40_0leadership_diff_name.adoc index bb5e37e..1d86420 100644 --- a/tests/docs/base/40_0leadership_diff_name.adoc +++ b/tests/docs/base/40_0leadership_diff_name.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leadership: description: a leadership @@ -19,7 +20,7 @@ leadership: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_empty.adoc b/tests/docs/base/40_0leadership_empty.adoc index eadc65f..741f544 100644 --- a/tests/docs/base/40_0leadership_empty.adoc +++ b/tests/docs/base/40_0leadership_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' empty_leader: type: leadership diff --git a/tests/docs/base/40_0leadership_follower_default_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_calculation.adoc index 93109f0..822d8bb 100644 --- a/tests/docs/base/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -24,7 +25,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti.adoc b/tests/docs/base/40_0leadership_follower_default_submulti.adoc index 154c92e..4e569ed 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -23,7 +24,7 @@ leader: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc index badc0a9..16d4469 100644 --- a/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc +++ b/tests/docs/base/40_0leadership_follower_default_submulti_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -25,7 +26,7 @@ leader: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_follower_default_value.adoc b/tests/docs/base/40_0leadership_follower_default_value.adoc index a9c44aa..fff852e 100644 --- a/tests/docs/base/40_0leadership_follower_default_value.adoc +++ b/tests/docs/base/40_0leadership_follower_default_value.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -21,7 +22,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_0leadership_leader_not_multi.adoc b/tests/docs/base/40_0leadership_leader_not_multi.adoc index be176b8..06b1f3f 100644 --- a/tests/docs/base/40_0leadership_leader_not_multi.adoc +++ b/tests/docs/base/40_0leadership_leader_not_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- general: mode_conteneur_actif: type: string @@ -28,7 +29,7 @@ version: '1.0' `standard` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -49,7 +50,7 @@ No change. + This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_1leadership_append_follower.adoc b/tests/docs/base/40_1leadership_append_follower.adoc index 88ce0c8..bcf9690 100644 --- a/tests/docs/base/40_1leadership_append_follower.adoc +++ b/tests/docs/base/40_1leadership_append_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: follower3: @@ -11,6 +12,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -32,7 +34,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_2leadership_calculation_index.adoc b/tests/docs/base/40_2leadership_calculation_index.adoc index 07857aa..f04006f 100644 --- a/tests/docs/base/40_2leadership_calculation_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_index.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -25,7 +26,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_2leadership_calculation_param_index.adoc b/tests/docs/base/40_2leadership_calculation_param_index.adoc index a3a7079..e2dd0c4 100644 --- a/tests/docs/base/40_2leadership_calculation_param_index.adoc +++ b/tests/docs/base/40_2leadership_calculation_param_index.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: leadership @@ -29,7 +30,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_2leadership_leader_calculation.adoc b/tests/docs/base/40_2leadership_leader_calculation.adoc index d941cd9..ee8f345 100644 --- a/tests/docs/base/40_2leadership_leader_calculation.adoc +++ b/tests/docs/base/40_2leadership_leader_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: @@ -30,7 +31,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_6leadership_follower_multi.adoc b/tests/docs/base/40_6leadership_follower_multi.adoc index 0f73f4a..e12b0fa 100644 --- a/tests/docs/base/40_6leadership_follower_multi.adoc +++ b/tests/docs/base/40_6leadership_follower_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leadership: description: A leadership @@ -27,7 +28,7 @@ leadership: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_boolean.adoc b/tests/docs/base/40_8calculation_boolean.adoc index ca44fba..9ff05cf 100644 --- a/tests/docs/base/40_8calculation_boolean.adoc +++ b/tests/docs/base/40_8calculation_boolean.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' bool: false # a boolean variable multi1: @@ -33,7 +34,7 @@ multi2: ---- == Variables for "rougail" -[cols="129a,129a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_boolean_return_none.adoc b/tests/docs/base/40_8calculation_boolean_return_none.adoc index b83f66c..105ae5d 100644 --- a/tests/docs/base/40_8calculation_boolean_return_none.adoc +++ b/tests/docs/base/40_8calculation_boolean_return_none.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: yes # a first variable var2: @@ -16,7 +17,7 @@ var2: ---- == Variables for "rougail" -[cols="109a,109a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_integer.adoc b/tests/docs/base/40_8calculation_integer.adoc index f21b1f1..1c6b405 100644 --- a/tests/docs/base/40_8calculation_integer.adoc +++ b/tests/docs/base/40_8calculation_integer.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' bool: false # a boolean variable int1: @@ -21,7 +22,7 @@ int2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_multi_variable.adoc b/tests/docs/base/40_8calculation_multi_variable.adoc index 8e7771d..06b3872 100644 --- a/tests/docs/base/40_8calculation_multi_variable.adoc +++ b/tests/docs/base/40_8calculation_multi_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a first variable @@ -13,7 +14,7 @@ var3: yes # a third variable ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent.adoc b/tests/docs/base/40_8calculation_multi_variable_parent.adoc index 00a5da9..aec74d5 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: no # a variable fam1: # a family @@ -12,7 +13,7 @@ fam1: # a family ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -26,7 +27,7 @@ A variable. + `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc index 63a4b1c..4d205a7 100644 --- a/tests/docs/base/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/base/40_8calculation_multi_variable_parent2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' fam1: # first family var: no # a variable @@ -17,7 +18,7 @@ fam2: # second family `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -31,7 +32,7 @@ A variable. + `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/41_0choice_leader.adoc b/tests/docs/base/41_0choice_leader.adoc index 9edf43e..a9de74a 100644 --- a/tests/docs/base/41_0choice_leader.adoc +++ b/tests/docs/base/41_0choice_leader.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: The leadership @@ -27,7 +28,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/44_0leadership_hidden.adoc b/tests/docs/base/44_0leadership_hidden.adoc index 6035ae2..adf33c9 100644 --- a/tests/docs/base/44_0leadership_hidden.adoc +++ b/tests/docs/base/44_0leadership_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: diff --git a/tests/docs/base/44_0leadership_leader_hidden.adoc b/tests/docs/base/44_0leadership_leader_hidden.adoc index fbd2146..fad00ea 100644 --- a/tests/docs/base/44_0leadership_leader_hidden.adoc +++ b/tests/docs/base/44_0leadership_leader_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: diff --git a/tests/docs/base/44_1leadership_append_hidden_follower.adoc b/tests/docs/base/44_1leadership_append_hidden_follower.adoc index ef0f10f..ce2f656 100644 --- a/tests/docs/base/44_1leadership_append_hidden_follower.adoc +++ b/tests/docs/base/44_1leadership_append_hidden_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: follower3: @@ -12,6 +13,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: description: a leadership diff --git a/tests/docs/base/44_4disabled_calcultion_follower.adoc b/tests/docs/base/44_4disabled_calcultion_follower.adoc index 7e100d5..0149fab 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.adoc +++ b/tests/docs/base/44_4disabled_calcultion_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # a condition leader: @@ -22,7 +23,7 @@ leader: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -39,7 +40,7 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -51,7 +52,7 @@ Aleader. + * a | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A follower. + **Disabled**: if condition is yes. |==== diff --git a/tests/docs/base/44_4disabled_calcultion_follower.md b/tests/docs/base/44_4disabled_calcultion_follower.md index c2cccd5..879c003 100644 --- a/tests/docs/base/44_4disabled_calcultion_follower.md +++ b/tests/docs/base/44_4disabled_calcultion_follower.md @@ -40,6 +40,6 @@ This family contains lists of variable blocks. | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | Aleader.
**Default**:
- a | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/base/44_4leadership_mandatory.adoc b/tests/docs/base/44_4leadership_mandatory.adoc index 68f1a2e..e5faad6 100644 --- a/tests/docs/base/44_4leadership_mandatory.adoc +++ b/tests/docs/base/44_4leadership_mandatory.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -23,7 +24,7 @@ leader: This family contains lists of variable blocks. -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/44_4leadership_mandatory_follower.adoc b/tests/docs/base/44_4leadership_mandatory_follower.adoc index 655519b..7198a00 100644 --- a/tests/docs/base/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/base/44_4leadership_mandatory_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: a leadership @@ -23,7 +24,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc index f63cf84..ff72621 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition leader: @@ -21,7 +22,7 @@ leader: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -33,14 +34,14 @@ A condition. + === a leadership -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is no. This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/44_5leadership_leader_hidden_calculation.md b/tests/docs/base/44_5leadership_leader_hidden_calculation.md index 56ddc13..54778a8 100644 --- a/tests/docs/base/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/base/44_5leadership_leader_hidden_calculation.md @@ -31,7 +31,7 @@ leader: ## a leadership -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is no. diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc index 672af35..953b144 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition leader: @@ -21,7 +22,7 @@ leader: ---- == Variables for "rougail" -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ This family contains lists of variable blocks. A leader. | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A follower. + **Disabled**: if condition is yes. |==== diff --git a/tests/docs/base/44_6leadership_follower_disabled_calculation.md b/tests/docs/base/44_6leadership_follower_disabled_calculation.md index aef9f48..e2e878a 100644 --- a/tests/docs/base/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/base/44_6leadership_follower_disabled_calculation.md @@ -39,6 +39,6 @@ This family contains lists of variable blocks. | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.adoc b/tests/docs/base/44_9calculated_default_leadership_leader.adoc index 45e9d84..60244aa 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.adoc +++ b/tests/docs/base/44_9calculated_default_leadership_leader.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 leader: description: leader @@ -29,7 +30,7 @@ leader: This family contains lists of variable blocks. -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ A leader. + * b | **rougail.leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `mandatory` `_disabled_` | A follower. + **Default**: the value of the variable "rougail.leader.leader". + **Disabled**: if the value of "leader" is "a". diff --git a/tests/docs/base/44_9calculated_default_leadership_leader.md b/tests/docs/base/44_9calculated_default_leadership_leader.md index 91f3a06..2d2c796 100644 --- a/tests/docs/base/44_9calculated_default_leadership_leader.md +++ b/tests/docs/base/44_9calculated_default_leadership_leader.md @@ -36,6 +36,6 @@ This family contains lists of variable blocks. | Variable                                                                                                                | Description                                                                                                             | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **rougail.leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` `unique` `multiple` | A leader.
**Default**:
- a
- b | -| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | A follower.
**Default**: the value of the variable "rougail.leader.leader".
**Disabled**: if the value of "leader" is "a". | +| **rougail.leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | A follower.
**Default**: the value of the variable "rougail.leader.leader".
**Disabled**: if the value of "leader" is "a". | diff --git a/tests/docs/base/60_0family_dynamic.adoc b/tests/docs/base/60_0family_dynamic.adoc index 79a57f2..0c76d2c 100644 --- a/tests/docs/base/60_0family_dynamic.adoc +++ b/tests/docs/base/60_0family_dynamic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable @@ -16,7 +17,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_1_0.adoc b/tests/docs/base/60_0family_dynamic_1_0.adoc index 2703c53..7432f58 100644 --- a/tests/docs/base/60_0family_dynamic_1_0.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: description: A suffix variable @@ -18,7 +19,7 @@ dyn: ---- == Variables for "rougail" -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -40,7 +41,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_1_0_type.adoc b/tests/docs/base/60_0family_dynamic_1_0_type.adoc index 5bc4449..8c0bba8 100644 --- a/tests/docs/base/60_0family_dynamic_1_0_type.adoc +++ b/tests/docs/base/60_0family_dynamic_1_0_type.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: description: A suffix variable @@ -17,7 +18,7 @@ dyn: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -39,7 +40,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_1_1.adoc b/tests/docs/base/60_0family_dynamic_1_1.adoc index 18f9868..86c6ee8 100644 --- a/tests/docs/base/60_0family_dynamic_1_1.adoc +++ b/tests/docs/base/60_0family_dynamic_1_1.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable - val1 @@ -15,7 +16,7 @@ dyn: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -37,7 +38,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_jinja_number.adoc b/tests/docs/base/60_0family_dynamic_jinja_number.adoc index 962e6e6..3a10d28 100644 --- a/tests/docs/base/60_0family_dynamic_jinja_number.adoc +++ b/tests/docs/base/60_0family_dynamic_jinja_number.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - 1 @@ -20,7 +21,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ A variable inside dynamic family. + **Default**: val |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_static.adoc b/tests/docs/base/60_0family_dynamic_static.adoc index 45f1aa8..3b517e5 100644 --- a/tests/docs/base/60_0family_dynamic_static.adoc +++ b/tests/docs/base/60_0family_dynamic_static.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' dyn{{ identifier }}: description: a dynamic family @@ -24,7 +25,7 @@ This family builds families dynamically. * val1 * val2 -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_test.adoc b/tests/docs/base/60_0family_dynamic_test.adoc index a60dc38..4573703 100644 --- a/tests/docs/base/60_0family_dynamic_test.adoc +++ b/tests/docs/base/60_0family_dynamic_test.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: @@ -20,7 +21,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_variable_empty.adoc b/tests/docs/base/60_0family_dynamic_variable_empty.adoc index b29fd77..acc4808 100644 --- a/tests/docs/base/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: [] # a suffix variable dyn{{ identifier }}: @@ -12,7 +13,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -30,7 +31,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc index 993e3a2..4c7f3f7 100644 --- a/tests/docs/base/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/base/60_0family_dynamic_variable_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable - val1 @@ -14,7 +15,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -36,7 +37,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_0family_empty.adoc b/tests/docs/base/60_0family_empty.adoc index 895216f..a86d76a 100644 --- a/tests/docs/base/60_0family_empty.adoc +++ b/tests/docs/base/60_0family_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' general2: type: family diff --git a/tests/docs/base/60_0family_hidden.adoc b/tests/docs/base/60_0family_hidden.adoc index b55cefc..60567a5 100644 --- a/tests/docs/base/60_0family_hidden.adoc +++ b/tests/docs/base/60_0family_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: # a family var: diff --git a/tests/docs/base/60_0family_mode.adoc b/tests/docs/base/60_0family_mode.adoc index 15dc0c8..b1fff4e 100644 --- a/tests/docs/base/60_0family_mode.adoc +++ b/tests/docs/base/60_0family_mode.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family var: @@ -15,7 +16,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_1family_dynamic_jinja.adoc b/tests/docs/base/60_1family_dynamic_jinja.adoc index a33a40b..a5db7f4 100644 --- a/tests/docs/base/60_1family_dynamic_jinja.adoc +++ b/tests/docs/base/60_1family_dynamic_jinja.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -18,7 +19,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -40,7 +41,7 @@ This family builds families dynamically. **Identifiers**: index of suffix value. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc index e31666d..a119b57 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a suffix variable - val1 @@ -21,7 +22,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ This family builds families dynamically. `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -56,7 +57,7 @@ This family builds families dynamically. With a variable. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc index 55af0e4..d7c585c 100644 --- a/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc +++ b/tests/docs/base/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a identifier variable - val1 @@ -25,7 +26,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -51,7 +52,7 @@ This family builds families dynamically. `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -61,7 +62,7 @@ A dynamic variable. + **Default**: the value of the identifier. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_2family_dynamic_outside_calc.adoc b/tests/docs/base/60_2family_dynamic_outside_calc.adoc index 001f0b1..a87b1d0 100644 --- a/tests/docs/base/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/base/60_2family_dynamic_outside_calc.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a suffx variable - val1 @@ -20,7 +21,7 @@ newvar: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ A dynamic variable. + **Default**: val |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_calc2.adoc b/tests/docs/base/60_5family_dynamic_calc2.adoc index 1401c60..3982389 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable @@ -25,7 +26,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -44,7 +45,7 @@ A second variable. === A dynamic family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: if var2 is no. @@ -53,7 +54,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_calc2.md b/tests/docs/base/60_5family_dynamic_calc2.md index bfa0086..26f51bf 100644 --- a/tests/docs/base/60_5family_dynamic_calc2.md +++ b/tests/docs/base/60_5family_dynamic_calc2.md @@ -36,7 +36,7 @@ dyn{{ identifier }}: ## A dynamic family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: if var2 is no. diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc index 4e3783c..ace2e8f 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: @@ -24,7 +25,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -46,7 +47,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -55,7 +56,7 @@ This family builds families dynamically. A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc index 0c8f72c..6c81679 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -17,7 +18,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -39,7 +40,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc index 1b613cc..59f658e 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' dyn{{ identifier }}: dynamic: @@ -27,12 +28,12 @@ This family builds families dynamically. * val1 * val2 -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | **rougail.dynval1.var** or **rougail.dynval2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A dynamic variable. + **Disabled**: when the identifier is "val1". |==== diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md index 8ba4dad..a0182e0 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_disabled.md @@ -30,6 +30,6 @@ This family builds families dynamically. | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A dynamic variable.
**Disabled**: when the identifier is "val1". | +| **rougail.dynval1.var** or **rougail.dynval2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A dynamic variable.
**Disabled**: when the identifier is "val1". | diff --git a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc index 85d2664..68856a5 100644 --- a/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_suffix_param.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A identifier variable - val1 @@ -22,7 +23,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -44,7 +45,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_calc_variable.adoc b/tests/docs/base/60_5family_dynamic_calc_variable.adoc index 236d17b..ce41325 100644 --- a/tests/docs/base/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/base/60_5family_dynamic_calc_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: A suffix variable @@ -21,7 +22,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -43,7 +44,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var1". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ This family builds families dynamically. A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc index 4907add..a8a28c1 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' dyn{{ identifier }}: description: a dynamic family @@ -30,7 +31,7 @@ dyn{{ identifier }}: === a dynamic family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: if suffix == 'val2'. @@ -42,7 +43,7 @@ This family builds families dynamically. * val1 * val2 -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -55,7 +56,7 @@ A variable. `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_hidden_suffix.md b/tests/docs/base/60_5family_dynamic_hidden_suffix.md index 0b2b9c4..e0353d3 100644 --- a/tests/docs/base/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/base/60_5family_dynamic_hidden_suffix.md @@ -34,7 +34,7 @@ dyn{{ identifier }}: ## a dynamic family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: if suffix == 'val2'. diff --git a/tests/docs/base/60_5family_dynamic_variable_outside.adoc b/tests/docs/base/60_5family_dynamic_variable_outside.adoc index aa55a0c..f2065c7 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -23,7 +24,7 @@ var2: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -45,7 +46,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -55,7 +56,7 @@ A variable inside a dynamic family. + **Default**: the value of the identifier. |==== -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc index 8de99e1..5382011 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside_jinja.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -29,7 +30,7 @@ var2: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -51,7 +52,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -61,7 +62,7 @@ A variable inside a dynamic family. + **Default**: the value of the identifier. |==== -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc index b25165d..604df18 100644 --- a/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/docs/base/60_5family_dynamic_variable_outside_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -21,7 +22,7 @@ var2: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -43,7 +44,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -53,7 +54,7 @@ A variable inside dynamic family. + **Default**: the value of the identifier. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_6family_dynamic_inside.adoc b/tests/docs/base/60_6family_dynamic_inside.adoc index 32dce15..1757fbd 100644 --- a/tests/docs/base/60_6family_dynamic_inside.adoc +++ b/tests/docs/base/60_6family_dynamic_inside.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -30,7 +31,7 @@ var: # a suffix variable ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_6family_dynamic_leadership.adoc b/tests/docs/base/60_6family_dynamic_leadership.adoc index 60adab5..93b8edd 100644 --- a/tests/docs/base/60_6family_dynamic_leadership.adoc +++ b/tests/docs/base/60_6family_dynamic_leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -25,7 +26,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -54,7 +55,7 @@ This family builds families dynamically. This family contains lists of variable blocks. -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc index 1e26e65..17547bd 100644 --- a/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc +++ b/tests/docs/base/60_6family_dynamic_sub_dynamic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A identifier variable - val1 @@ -48,7 +49,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -70,7 +71,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -89,7 +90,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.dyn{{ identifier }}.var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_9extra_dynamic.adoc b/tests/docs/base/60_9extra_dynamic.adoc index 46d50f9..ec38e55 100644 --- a/tests/docs/base/60_9extra_dynamic.adoc +++ b/tests/docs/base/60_9extra_dynamic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var: # a variable - a @@ -10,6 +11,7 @@ var: # a variable [,yaml] ---- +--- version: 1.1 dyn_{{ identifier }}: dynamic: @@ -18,7 +20,7 @@ dyn_{{ identifier }}: ---- == Variables for "rougail" -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +44,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_9extra_dynamic_extra.adoc b/tests/docs/base/60_9extra_dynamic_extra.adoc index 7f2fc06..7d5511a 100644 --- a/tests/docs/base/60_9extra_dynamic_extra.adoc +++ b/tests/docs/base/60_9extra_dynamic_extra.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- general: description: général varname: @@ -16,6 +17,7 @@ version: '1.0' [,yaml] ---- +--- version: '1.1' var: # a varaible - a @@ -30,7 +32,7 @@ dyn_{{ identifier }}: `standard` -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -45,7 +47,7 @@ No change. + == Variables for "extra" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -66,7 +68,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "extra.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/60_9family_dynamic_calc_both.adoc b/tests/docs/base/60_9family_dynamic_calc_both.adoc index ffa9eb4..ff3e9e5 100644 --- a/tests/docs/base/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/base/60_9family_dynamic_calc_both.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: val2 # a suffix variable dyn{{ identifier }}: @@ -13,7 +14,7 @@ dyn{{ identifier }}: ---- == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -35,7 +36,7 @@ This family builds families dynamically. * val1 * the value of the variable "rougail.var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/base/68_0family_leadership_mode.adoc b/tests/docs/base/68_0family_leadership_mode.adoc index 3ef5eb0..5d6ffb0 100644 --- a/tests/docs/base/68_0family_leadership_mode.adoc +++ b/tests/docs/base/68_0family_leadership_mode.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: A leadership @@ -26,7 +27,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_0version_underscore.adoc b/tests/docs/no_namespace/00_0version_underscore.adoc index 525ba40..d048ae9 100644 --- a/tests/docs/no_namespace/00_0version_underscore.adoc +++ b/tests/docs/no_namespace/00_0version_underscore.adoc @@ -2,12 +2,13 @@ [,yaml] ---- +--- _version: '1.1' version: # a variable ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_1empty_variable.adoc b/tests/docs/no_namespace/00_1empty_variable.adoc index e7b9268..512602a 100644 --- a/tests/docs/no_namespace/00_1empty_variable.adoc +++ b/tests/docs/no_namespace/00_1empty_variable.adoc @@ -2,12 +2,13 @@ [,yaml] ---- +--- version: '1.0' empty: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_2default_calculated.adoc b/tests/docs/no_namespace/00_2default_calculated.adoc index c9da8d1..5f40f25 100644 --- a/tests/docs/no_namespace/00_2default_calculated.adoc +++ b/tests/docs/no_namespace/00_2default_calculated.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: no # a first variable var2: @@ -14,7 +15,7 @@ var2: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_2default_calculated_multi.adoc b/tests/docs/no_namespace/00_2default_calculated_multi.adoc index 511da85..5613c97 100644 --- a/tests/docs/no_namespace/00_2default_calculated_multi.adoc +++ b/tests/docs/no_namespace/00_2default_calculated_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: # a first variable - no @@ -19,7 +20,7 @@ var2: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc index 06745eb..9143058 100644 --- a/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc +++ b/tests/docs/no_namespace/00_2default_calculated_variable_transitive.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -19,7 +20,7 @@ var2: ---- == Variables -[cols="132a,132a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_4load_subfolder.adoc b/tests/docs/no_namespace/00_4load_subfolder.adoc index 364ecd2..5e9b1af 100644 --- a/tests/docs/no_namespace/00_4load_subfolder.adoc +++ b/tests/docs/no_namespace/00_4load_subfolder.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var1: description: a variable @@ -10,13 +11,14 @@ var1: [,yaml] ---- +--- version: '1.0' var2: description: a variable ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_5load_notype.adoc b/tests/docs/no_namespace/00_5load_notype.adoc index 06ccddb..0b670ed 100644 --- a/tests/docs/no_namespace/00_5load_notype.adoc +++ b/tests/docs/no_namespace/00_5load_notype.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' without_type: description: a variable @@ -9,7 +10,7 @@ without_type: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6boolean.adoc b/tests/docs/no_namespace/00_6boolean.adoc index d08d942..f42fd48 100644 --- a/tests/docs/no_namespace/00_6boolean.adoc +++ b/tests/docs/no_namespace/00_6boolean.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: true # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables -[cols="109a,109a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc index aee8752..07e68d4 100644 --- a/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc +++ b/tests/docs/no_namespace/00_6boolean_no_mandatory.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="97a,97a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6choice.adoc b/tests/docs/no_namespace/00_6choice.adoc index f423851..2f4df92 100644 --- a/tests/docs/no_namespace/00_6choice.adoc +++ b/tests/docs/no_namespace/00_6choice.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: the first variable @@ -46,7 +47,7 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6choice_calculation.adoc b/tests/docs/no_namespace/00_6choice_calculation.adoc index 4d33fe3..c3dce9e 100644 --- a/tests/docs/no_namespace/00_6choice_calculation.adoc +++ b/tests/docs/no_namespace/00_6choice_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6choice_variable.adoc b/tests/docs/no_namespace/00_6choice_variable.adoc index e0004a0..d9972b9 100644 --- a/tests/docs/no_namespace/00_6choice_variable.adoc +++ b/tests/docs/no_namespace/00_6choice_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a second variable - a @@ -15,7 +16,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6custom.adoc b/tests/docs/no_namespace/00_6custom.adoc index fa1da29..57069c8 100644 --- a/tests/docs/no_namespace/00_6custom.adoc +++ b/tests/docs/no_namespace/00_6custom.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' custom1: description: the first variable @@ -13,7 +14,7 @@ custom2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6domainname.adoc b/tests/docs/no_namespace/00_6domainname.adoc index 3125c57..bf6541f 100644 --- a/tests/docs/no_namespace/00_6domainname.adoc +++ b/tests/docs/no_namespace/00_6domainname.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a domain name variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="112a,112a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6domainname_params.adoc b/tests/docs/no_namespace/00_6domainname_params.adoc index 228c717..148c3f3 100644 --- a/tests/docs/no_namespace/00_6domainname_params.adoc +++ b/tests/docs/no_namespace/00_6domainname_params.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a domain name variable @@ -12,7 +13,7 @@ variable: ---- == Variables -[cols="112a,112a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6float.adoc b/tests/docs/no_namespace/00_6float.adoc index deced13..7037140 100644 --- a/tests/docs/no_namespace/00_6float.adoc +++ b/tests/docs/no_namespace/00_6float.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: 0.0 # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6number.adoc b/tests/docs/no_namespace/00_6number.adoc index d9ae3ae..cd3f255 100644 --- a/tests/docs/no_namespace/00_6number.adoc +++ b/tests/docs/no_namespace/00_6number.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: 0 # the first variable var2: @@ -22,7 +23,7 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6port.adoc b/tests/docs/no_namespace/00_6port.adoc index f55c25a..a7a23f9 100644 --- a/tests/docs/no_namespace/00_6port.adoc +++ b/tests/docs/no_namespace/00_6port.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: description: a port variable @@ -17,7 +18,7 @@ variable3: ---- == Variables -[cols="106a,106a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6regexp.adoc b/tests/docs/no_namespace/00_6regexp.adoc index 7ab87a4..4f8b2cc 100644 --- a/tests/docs/no_namespace/00_6regexp.adoc +++ b/tests/docs/no_namespace/00_6regexp.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a first variable @@ -13,7 +14,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_6string.adoc b/tests/docs/no_namespace/00_6string.adoc index bfc7917..dbc3d57 100644 --- a/tests/docs/no_namespace/00_6string.adoc +++ b/tests/docs/no_namespace/00_6string.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable var2: @@ -21,7 +22,7 @@ var6: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7choice_quote.adoc b/tests/docs/no_namespace/00_7choice_quote.adoc index ca7bd4f..59f1ff8 100644 --- a/tests/docs/no_namespace/00_7choice_quote.adoc +++ b/tests/docs/no_namespace/00_7choice_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: type: choice @@ -14,7 +15,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7help_quote.adoc b/tests/docs/no_namespace/00_7help_quote.adoc index 167b164..79e4f67 100644 --- a/tests/docs/no_namespace/00_7help_quote.adoc +++ b/tests/docs/no_namespace/00_7help_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var1: description: the first variable @@ -12,7 +13,7 @@ var2: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7value_doublequote.adoc b/tests/docs/no_namespace/00_7value_doublequote.adoc index fca803d..3139c7b 100644 --- a/tests/docs/no_namespace/00_7value_doublequote.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7value_doublequote2.adoc b/tests/docs/no_namespace/00_7value_doublequote2.adoc index 230a8c7..9a80a12 100644 --- a/tests/docs/no_namespace/00_7value_doublequote2.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7value_doublequote3.adoc b/tests/docs/no_namespace/00_7value_doublequote3.adoc index 27e028b..cd1ba85 100644 --- a/tests/docs/no_namespace/00_7value_doublequote3.adoc +++ b/tests/docs/no_namespace/00_7value_doublequote3.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_7value_quote.adoc b/tests/docs/no_namespace/00_7value_quote.adoc index 5269c02..dd65ec1 100644 --- a/tests/docs/no_namespace/00_7value_quote.adoc +++ b/tests/docs/no_namespace/00_7value_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' variable: description: a variable @@ -9,7 +10,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_8calculation_information.adoc b/tests/docs/no_namespace/00_8calculation_information.adoc index 930eab7..cf2eff2 100644 --- a/tests/docs/no_namespace/00_8calculation_information.adoc +++ b/tests/docs/no_namespace/00_8calculation_information.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -16,7 +17,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_8test.adoc b/tests/docs/no_namespace/00_8test.adoc index 9c485c5..8df03ba 100644 --- a/tests/docs/no_namespace/00_8test.adoc +++ b/tests/docs/no_namespace/00_8test.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: @@ -44,7 +45,7 @@ var6: ---- == Variables -[cols="125a,125a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9choice_variable_multi.adoc b/tests/docs/no_namespace/00_9choice_variable_multi.adoc index 81f0774..21503dc 100644 --- a/tests/docs/no_namespace/00_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/00_9choice_variable_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: description: a first variable @@ -21,7 +22,7 @@ variable2: ---- == Variables -[cols="116a,116a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9choice_variables.adoc b/tests/docs/no_namespace/00_9choice_variables.adoc index 75c0673..1151e97 100644 --- a/tests/docs/no_namespace/00_9choice_variables.adoc +++ b/tests/docs/no_namespace/00_9choice_variables.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' source_variable_1: val1 # the first source variable source_variable_2: val2 # the second source variable @@ -15,7 +16,7 @@ my_variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation.adoc b/tests/docs/no_namespace/00_9default_calculation.adoc index 6108b1b..d257b01 100644 --- a/tests/docs/no_namespace/00_9default_calculation.adoc +++ b/tests/docs/no_namespace/00_9default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: @@ -18,7 +19,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_information.adoc b/tests/docs/no_namespace/00_9default_calculation_information.adoc index 2a0cea2..d400f21 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_information.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc index c477f02..7bad338 100644 --- a/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_information_other_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a first variable var2: @@ -17,7 +18,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc index 4bc7022..ebd1051 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: default: val1 @@ -15,7 +16,7 @@ my_calculated_variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc index 54afa56..d054792 100644 --- a/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_multi_optional2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: default: val1 @@ -15,7 +16,7 @@ my_calculated_variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_optional.adoc index ba8cb8e..ed1762e 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_calculated_variable: multi: true @@ -11,7 +12,7 @@ my_calculated_variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc index 9d86e74..7fd96e5 100644 --- a/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_optional_exists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 my_variable: multi: true @@ -16,7 +17,7 @@ my_calculated_variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc index bc9e12d..219c2e7 100644 --- a/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc +++ b/tests/docs/no_namespace/00_9default_calculation_param_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a first variable @@ -24,7 +25,7 @@ var2: no # a second variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_information_other_variable.adoc b/tests/docs/no_namespace/00_9default_information_other_variable.adoc index 51cce68..bf3995f 100644 --- a/tests/docs/no_namespace/00_9default_information_other_variable.adoc +++ b/tests/docs/no_namespace/00_9default_information_other_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a first variable var2: @@ -13,7 +14,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/00_9default_integer.adoc b/tests/docs/no_namespace/00_9default_integer.adoc index 05e0940..7c94279 100644 --- a/tests/docs/no_namespace/00_9default_integer.adoc +++ b/tests/docs/no_namespace/00_9default_integer.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a variable @@ -16,7 +17,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6boolean_multi.adoc b/tests/docs/no_namespace/01_6boolean_multi.adoc index 2804505..2e43bdb 100644 --- a/tests/docs/no_namespace/01_6boolean_multi.adoc +++ b/tests/docs/no_namespace/01_6boolean_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - true @@ -40,7 +41,7 @@ var8: ---- == Variables -[cols="129a,129a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6custom_multi.adoc b/tests/docs/no_namespace/01_6custom_multi.adoc index 5bb16a7..ff5d6e1 100644 --- a/tests/docs/no_namespace/01_6custom_multi.adoc +++ b/tests/docs/no_namespace/01_6custom_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' custom1: description: a first custom variable @@ -15,7 +16,7 @@ custom2: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6float_multi.adoc b/tests/docs/no_namespace/01_6float_multi.adoc index 847239c..14634e6 100644 --- a/tests/docs/no_namespace/01_6float_multi.adoc +++ b/tests/docs/no_namespace/01_6float_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - 0.0 @@ -40,7 +41,7 @@ var8: ---- == Variables -[cols="127a,127a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6number_multi.adoc b/tests/docs/no_namespace/01_6number_multi.adoc index e3f0435..d4642ce 100644 --- a/tests/docs/no_namespace/01_6number_multi.adoc +++ b/tests/docs/no_namespace/01_6number_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # the first variable - 0 @@ -40,7 +41,7 @@ var8: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6string_empty.adoc b/tests/docs/no_namespace/01_6string_empty.adoc index 4cc7686..1c7a4b3 100644 --- a/tests/docs/no_namespace/01_6string_empty.adoc +++ b/tests/docs/no_namespace/01_6string_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: the second variable @@ -10,7 +11,7 @@ var1: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_6string_multi.adoc b/tests/docs/no_namespace/01_6string_multi.adoc index 286560c..d05501f 100644 --- a/tests/docs/no_namespace/01_6string_multi.adoc +++ b/tests/docs/no_namespace/01_6string_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: [] # the first variable var2: @@ -36,7 +37,7 @@ var8: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc index c54953c..32c1119 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc index 0772144..ce7bd7c 100644 --- a/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc +++ b/tests/docs/no_namespace/01_7value_multi_doublequote2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_7value_multi_quote.adoc b/tests/docs/no_namespace/01_7value_multi_quote.adoc index 6c83724..6da1d87 100644 --- a/tests/docs/no_namespace/01_7value_multi_quote.adoc +++ b/tests/docs/no_namespace/01_7value_multi_quote.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_8calculation_information_multi.adoc b/tests/docs/no_namespace/01_8calculation_information_multi.adoc index 058adf0..95d7535 100644 --- a/tests/docs/no_namespace/01_8calculation_information_multi.adoc +++ b/tests/docs/no_namespace/01_8calculation_information_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -17,7 +18,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/01_9choice_variable_multi.adoc b/tests/docs/no_namespace/01_9choice_variable_multi.adoc index 4038220..b37b147 100644 --- a/tests/docs/no_namespace/01_9choice_variable_multi.adoc +++ b/tests/docs/no_namespace/01_9choice_variable_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable1: # a first variable - a @@ -14,7 +15,7 @@ variable2: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_0type_param.adoc b/tests/docs/no_namespace/04_0type_param.adoc index d123a94..6e57a95 100644 --- a/tests/docs/no_namespace/04_0type_param.adoc +++ b/tests/docs/no_namespace/04_0type_param.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' int: description: A limited number @@ -12,7 +13,7 @@ int: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_1auto_save.adoc b/tests/docs/no_namespace/04_1auto_save.adoc index b695459..2919884 100644 --- a/tests/docs/no_namespace/04_1auto_save.adoc +++ b/tests/docs/no_namespace/04_1auto_save.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 variable: description: an auto save variable @@ -10,7 +11,7 @@ variable: ---- == Variables -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc index 667e1c3..283c669 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: no # a first variable var2: @@ -12,7 +13,7 @@ var2: ---- == Variables -[cols="121a,121a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc index 45d3e9f..86cd46b 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: @@ -19,7 +20,7 @@ var2: ---- == Variables -[cols="132a,132a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -29,7 +30,7 @@ A first variable. + **Default**: no | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ `auto modified` | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` `auto modified` | A second variable. + **Default**: the value is always yes. + **Hidden**: only if the variable var1 has value "yes". diff --git a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md index 0e78bbb..5ecb4ca 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md +++ b/tests/docs/no_namespace/04_1auto_save_and_calculated_hidden.md @@ -26,6 +26,6 @@ var2: | Variable                                                                                                                           | Description                                                                                                                        | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: no | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`hidden`* `auto modified` | A second variable.
**Default**: the value is always yes.
**Hidden**: only if the variable var1 has value "yes". | diff --git a/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc index 4dfe262..5fa72fd 100644 --- a/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc +++ b/tests/docs/no_namespace/04_1auto_save_and_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: autosave variable diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc index 7887050..52ec7d9 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden.adoc +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -24,7 +25,7 @@ var3: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -34,7 +35,7 @@ A first variable. + **Default**: value | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A second variable. + **Disabled**: when the variable "var1" has the value "value". | diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden.md b/tests/docs/no_namespace/04_1default_calculation_hidden.md index d219c5a..8ed3742 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden.md +++ b/tests/docs/no_namespace/04_1default_calculation_hidden.md @@ -31,7 +31,7 @@ var3: | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc index a84a209..a9db642 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: @@ -24,7 +25,7 @@ var3: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -34,7 +35,7 @@ A first variable. + **Default**: value | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A second variable. + **Disabled**: when the variable "var1" has the value "value". | diff --git a/tests/docs/no_namespace/04_1default_calculation_hidden_2.md b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md index 2035543..61429fb 100644 --- a/tests/docs/no_namespace/04_1default_calculation_hidden_2.md +++ b/tests/docs/no_namespace/04_1default_calculation_hidden_2.md @@ -31,7 +31,7 @@ var3: | Variable                                                                                                   | Description                                                                                                | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A first variable.
**Default**: value | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A second variable.
**Disabled**: when the variable "var1" has the value "value". | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A second variable.
**Disabled**: when the variable "var1" has the value "value". | | **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A third variable.
**Default**: depends on a calculation. | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc index c16b836..e607c90 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var1: @@ -37,7 +38,7 @@ var2: ---- == Variables -[cols="107a,107a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,12 +48,12 @@ A condition. + **Default**: no | **var1** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_hidden_` | A first variable. + **Hidden**: calculation from an unknown variable. | **var2** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_hidden_` | A second variable. + **Hidden**: calculation from an condition variable. |==== diff --git a/tests/docs/no_namespace/04_5disabled_calculation_optional.md b/tests/docs/no_namespace/04_5disabled_calculation_optional.md index f18e59c..54880ce 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_optional.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_optional.md @@ -44,7 +44,7 @@ var2: | Variable                                                                                                  | Description                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`hidden`_ | A first variable.
**Hidden**: calculation from an unknown variable. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`hidden`_ | A second variable.
**Hidden**: calculation from an condition variable. | +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A first variable.
**Hidden**: calculation from an unknown variable. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* | A second variable.
**Hidden**: calculation from an condition variable. | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc index eebc384..00be5d2 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: false # a condition variable: @@ -11,7 +12,7 @@ variable: ---- == Variables -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: False | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "condition" has the value "True". |==== diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable.md b/tests/docs/no_namespace/04_5disabled_calculation_variable.md index 03004bb..07100ba 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable.md @@ -18,6 +18,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: False | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "True". | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc index f5c69ca..0b0bd16 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # a condition variable: @@ -11,7 +12,7 @@ variable: ---- == Variables -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: True | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "condition" has the value "True". |==== diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md index 2982025..0f3a79c 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable2.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable2.md @@ -18,6 +18,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "True". | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "True". | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc index 1198ec6..c30c125 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition variable: @@ -12,7 +13,7 @@ variable: ---- == Variables -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -22,7 +23,7 @@ A condition. + **Default**: yes | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "condition" has the value "yes". |==== diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md index 7d9975a..9bbd2be 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable3.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable3.md @@ -19,6 +19,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" has the value "yes". | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" has the value "yes". | diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc index 236f89f..d267427 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition variable: @@ -12,7 +13,7 @@ variable: ---- == Variables -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -22,7 +23,7 @@ A condition. + **Default**: yes | **variable** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A variable. + **Disabled**: when the variable "condition" hasn't the value "yes". |==== diff --git a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md index b840d44..d3fb05b 100644 --- a/tests/docs/no_namespace/04_5disabled_calculation_variable4.md +++ b/tests/docs/no_namespace/04_5disabled_calculation_variable4.md @@ -19,6 +19,6 @@ variable: | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: yes | -| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A variable.
**Disabled**: when the variable "condition" hasn't the value "yes". | +| **variable**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A variable.
**Disabled**: when the variable "condition" hasn't the value "yes". | diff --git a/tests/docs/no_namespace/04_5validators.adoc b/tests/docs/no_namespace/04_5validators.adoc index fe85800..f19d451 100644 --- a/tests/docs/no_namespace/04_5validators.adoc +++ b/tests/docs/no_namespace/04_5validators.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' int: description: A number @@ -15,7 +16,7 @@ int: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_5validators_differ.adoc b/tests/docs/no_namespace/04_5validators_differ.adoc index 7b767cc..0a67035 100644 --- a/tests/docs/no_namespace/04_5validators_differ.adoc +++ b/tests/docs/no_namespace/04_5validators_differ.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a first variable @@ -19,7 +20,7 @@ var2: no # A second variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_5validators_in_network.adoc b/tests/docs/no_namespace/04_5validators_in_network.adoc deleted file mode 100644 index 54b19e8..0000000 --- a/tests/docs/no_namespace/04_5validators_in_network.adoc +++ /dev/null @@ -1,62 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Network address - type: netmask -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} - {% endif %} - description: check if IP in the previous network ----- -== Variables - -[cols="101a,101a",options="header"] -|==== -| Variable | Description -| -**network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | -Network address. -| -**netmask_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | -Network address. -| -**ip_address** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | -An IP. + -**Validators**: - -* reserved IP are allowed -* check if IP in the previous network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -ip_address: 1.1.1.1 ----- -== Example with all variables modifiable - -[,yaml] ----- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -ip_address: 1.1.1.1 ----- diff --git a/tests/docs/no_namespace/04_5validators_in_network.md b/tests/docs/no_namespace/04_5validators_in_network.md deleted file mode 100644 index 58317ea..0000000 --- a/tests/docs/no_namespace/04_5validators_in_network.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Network address - type: netmask -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }} - {% endif %} - description: check if IP in the previous network -``` -# Variables - -| Variable                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- check if IP in the previous network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -ip_address: 1.1.1.1 -``` -# Example with all variables modifiable - -```yaml ---- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -ip_address: 1.1.1.1 -``` diff --git a/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc b/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc deleted file mode 100644 index 80dc9a0..0000000 --- a/tests/docs/no_namespace/04_5validators_in_network_cidr.adoc +++ /dev/null @@ -1,53 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: cidr -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} - {% endif %} - description: this IP must be in network ----- -== Variables - -[cols="101a,101a",options="header"] -|==== -| Variable | Description -| -**network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[cidr]` `basic` `mandatory` | -Network address. -| -**ip_address** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` | -An IP. + -**Validators**: - -* reserved IP are allowed -* this IP must be in network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -network_address_eth0: 1.1.1.0/24 -ip_address: 1.1.1.1 ----- -== Example with all variables modifiable - -[,yaml] ----- -network_address_eth0: 1.1.1.0/24 -ip_address: 1.1.1.1 ----- diff --git a/tests/docs/no_namespace/04_5validators_in_network_cidr.md b/tests/docs/no_namespace/04_5validators_in_network_cidr.md deleted file mode 100644 index 9a85ab7..0000000 --- a/tests/docs/no_namespace/04_5validators_in_network_cidr.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: cidr -ip_address: - description: an IP - type: ip - validators: - - type: jinja - jinja: | - {% if not _.ip_address | valid_in_network(_.network_address_eth0) %} - {{ _.ip_address }} is not in network {{ _.network_address_eth0 }} - {% endif %} - description: this IP must be in network -``` -# Variables - -| Variable                                                                                            | Description                                                                                         | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **network_address_eth0**
[`cidr`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **ip_address**
[`IP`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | An IP.
**Validators**:
- reserved IP are allowed
- this IP must be in network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -network_address_eth0: 1.1.1.0/24 -ip_address: 1.1.1.1 -``` -# Example with all variables modifiable - -```yaml ---- -network_address_eth0: 1.1.1.0/24 -ip_address: 1.1.1.1 -``` diff --git a/tests/docs/no_namespace/04_5validators_ipnetmask.adoc b/tests/docs/no_namespace/04_5validators_ipnetmask.adoc deleted file mode 100644 index ceb1ea6..0000000 --- a/tests/docs/no_namespace/04_5validators_ipnetmask.adoc +++ /dev/null @@ -1,50 +0,0 @@ -== dictionaries/rougail/00-base.yml - -[,yaml] ----- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Netmask address - type: netmask - validators: - - type: jinja - jinja: | - {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} - {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} - {% endif %} - description: this mask is possible for the network ----- -== Variables - -[cols="106a,106a",options="header"] -|==== -| Variable | Description -| -**network_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` | -Network address. -| -**netmask_address_eth0** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` | -Netmask address. + -**Validator**: this mask is possible for the network. -|==== - - -== Example with mandatory variables not filled in - -[,yaml] ----- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 ----- -== Example with all variables modifiable - -[,yaml] ----- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 ----- diff --git a/tests/docs/no_namespace/04_5validators_ipnetmask.md b/tests/docs/no_namespace/04_5validators_ipnetmask.md deleted file mode 100644 index eaf18ba..0000000 --- a/tests/docs/no_namespace/04_5validators_ipnetmask.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -gitea: none -include_toc: true ---- -# dictionaries/rougail/00-base.yml - -```yaml ---- -version: '1.1' -network_address_eth0: - description: Network address - type: network -netmask_address_eth0: - description: Netmask address - type: netmask - validators: - - type: jinja - jinja: | - {% if not _.netmask_address_eth0 | valid_in_network(_.network_address_eth0) %} - {{ _.netmask_address_eth0 }} is not a netmask for network {{ _.network_address_eth0 }} - {% endif %} - description: this mask is possible for the network -``` -# Variables - -| Variable                                                                                                 | Description                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **network_address_eth0**
[`network`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Network address. | -| **netmask_address_eth0**
[`netmask`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Netmask address.
**Validator**: this mask is possible for the network. | - - -# Example with mandatory variables not filled in - -```yaml ---- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -``` -# Example with all variables modifiable - -```yaml ---- -network_address_eth0: 1.1.1.0 -netmask_address_eth0: 255.255.255.0 -``` diff --git a/tests/docs/no_namespace/04_5validators_multi.adoc b/tests/docs/no_namespace/04_5validators_multi.adoc index c464402..68de870 100644 --- a/tests/docs/no_namespace/04_5validators_multi.adoc +++ b/tests/docs/no_namespace/04_5validators_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: description: a second variable @@ -18,7 +19,7 @@ var1: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_5validators_multi2.adoc b/tests/docs/no_namespace/04_5validators_multi2.adoc index ff461d2..27077e3 100644 --- a/tests/docs/no_namespace/04_5validators_multi2.adoc +++ b/tests/docs/no_namespace/04_5validators_multi2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var1: description: a second variable @@ -25,7 +26,7 @@ var1: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/04_7validators_variable_optional.adoc b/tests/docs/no_namespace/04_7validators_variable_optional.adoc index e8fed68..7d51479 100644 --- a/tests/docs/no_namespace/04_7validators_variable_optional.adoc +++ b/tests/docs/no_namespace/04_7validators_variable_optional.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' general: # a family int: @@ -36,7 +37,7 @@ general: # a family `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/05_0multi_not_uniq.adoc b/tests/docs/no_namespace/05_0multi_not_uniq.adoc index 91af1fc..47398ed 100644 --- a/tests/docs/no_namespace/05_0multi_not_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_not_uniq.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: a variable @@ -11,7 +12,7 @@ var1: ---- == Variables -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/05_0multi_uniq.adoc b/tests/docs/no_namespace/05_0multi_uniq.adoc index d02b672..287862b 100644 --- a/tests/docs/no_namespace/05_0multi_uniq.adoc +++ b/tests/docs/no_namespace/05_0multi_uniq.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,7 +12,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/12_1auto_save_expert.adoc b/tests/docs/no_namespace/12_1auto_save_expert.adoc index b2fa8f9..82f7a9f 100644 --- a/tests/docs/no_namespace/12_1auto_save_expert.adoc +++ b/tests/docs/no_namespace/12_1auto_save_expert.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 var: description: a variable diff --git a/tests/docs/no_namespace/16_0redefine_description.adoc b/tests/docs/no_namespace/16_0redefine_description.adoc index 48fd5d7..7fce84e 100644 --- a/tests/docs/no_namespace/16_0redefine_description.adoc +++ b/tests/docs/no_namespace/16_0redefine_description.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: Redefine description @@ -10,6 +11,7 @@ var: [,yaml] ---- +--- version: '1.1' var: description: Redefined @@ -17,7 +19,7 @@ var: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc index d37b54c..c22cb36 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' family: redefine: true @@ -13,6 +14,7 @@ family: [,yaml] ---- +--- version: '1.0' family: var1: @@ -21,11 +23,11 @@ family: === family -`basic` _`disabled`_ +`basic` `_disabled_` **Disabled**: depends on a calculation. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_2family_redefine_calculation.md b/tests/docs/no_namespace/16_2family_redefine_calculation.md index c685590..a9ecc96 100644 --- a/tests/docs/no_namespace/16_2family_redefine_calculation.md +++ b/tests/docs/no_namespace/16_2family_redefine_calculation.md @@ -25,7 +25,7 @@ family: ## family -`basic` _`disabled`_ +`basic` *`disabled`* **Disabled**: depends on a calculation. diff --git a/tests/docs/no_namespace/16_2family_redefine_disabled.adoc b/tests/docs/no_namespace/16_2family_redefine_disabled.adoc index 14f798a..4b2cf1e 100644 --- a/tests/docs/no_namespace/16_2family_redefine_disabled.adoc +++ b/tests/docs/no_namespace/16_2family_redefine_disabled.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.0' family: var1: diff --git a/tests/docs/no_namespace/16_5exists_nonexists.adoc b/tests/docs/no_namespace/16_5exists_nonexists.adoc index cc70d28..5bf5be0 100644 --- a/tests/docs/no_namespace/16_5exists_nonexists.adoc +++ b/tests/docs/no_namespace/16_5exists_nonexists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var2: description: a new variable @@ -12,12 +13,13 @@ var2: [,yaml] ---- +--- version: '1.1' var1: no # a variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5exists_redefine.adoc b/tests/docs/no_namespace/16_5exists_redefine.adoc index ffd4c3d..3a8a3a3 100644 --- a/tests/docs/no_namespace/16_5exists_redefine.adoc +++ b/tests/docs/no_namespace/16_5exists_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: redefine: true @@ -17,6 +18,7 @@ var2: [,yaml] ---- +--- version: '1.1' var1: description: a first variable diff --git a/tests/docs/no_namespace/16_5redefine_calculation.adoc b/tests/docs/no_namespace/16_5redefine_calculation.adoc index 745d8f3..c4fd03b 100644 --- a/tests/docs/no_namespace/16_5redefine_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -13,6 +14,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -22,7 +24,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_choice.adoc b/tests/docs/no_namespace/16_5redefine_choice.adoc index b1b3d28..2ad8898 100644 --- a/tests/docs/no_namespace/16_5redefine_choice.adoc +++ b/tests/docs/no_namespace/16_5redefine_choice.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -14,6 +15,7 @@ variable: [,yaml] ---- +--- version: '1.0' variable: redefine: true @@ -23,7 +25,7 @@ variable: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_default.adoc b/tests/docs/no_namespace/16_5redefine_default.adoc index 9f08320..e1427de 100644 --- a/tests/docs/no_namespace/16_5redefine_default.adoc +++ b/tests/docs/no_namespace/16_5redefine_default.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -18,7 +20,7 @@ variable: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc index 025f096..bea1598 100644 --- a/tests/docs/no_namespace/16_5redefine_default_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -19,7 +21,7 @@ variable: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_family.adoc b/tests/docs/no_namespace/16_5redefine_family.adoc index 375ceab..d3b4168 100644 --- a/tests/docs/no_namespace/16_5redefine_family.adoc +++ b/tests/docs/no_namespace/16_5redefine_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: # a family variable: # a variable @@ -21,7 +23,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_help.adoc b/tests/docs/no_namespace/16_5redefine_help.adoc index e572c57..d37e864 100644 --- a/tests/docs/no_namespace/16_5redefine_help.adoc +++ b/tests/docs/no_namespace/16_5redefine_help.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -14,6 +15,7 @@ family: [,yaml] ---- +--- version: '1.1' family: description: a family @@ -31,7 +33,7 @@ family: Redefine help family ok. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_hidden.adoc b/tests/docs/no_namespace/16_5redefine_hidden.adoc index e6861a6..cb09425 100644 --- a/tests/docs/no_namespace/16_5redefine_hidden.adoc +++ b/tests/docs/no_namespace/16_5redefine_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: no # a variable ---- @@ -9,6 +10,7 @@ variable: no # a variable [,yaml] ---- +--- version: '1.1' variable: redefine: true diff --git a/tests/docs/no_namespace/16_5redefine_multi.adoc b/tests/docs/no_namespace/16_5redefine_multi.adoc index 4898672..00824e9 100644 --- a/tests/docs/no_namespace/16_5redefine_multi.adoc +++ b/tests/docs/no_namespace/16_5redefine_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: description: a variable @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -20,7 +22,7 @@ variable: ---- == Variables -[cols="128a,128a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc index df8a614..2cd7c4e 100644 --- a/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc +++ b/tests/docs/no_namespace/16_5redefine_remove_disable_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: redefine: true @@ -11,6 +12,7 @@ variable: [,yaml] ---- +--- version: '1.1' condition: no # a condition variable: @@ -25,7 +27,7 @@ variable: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_5test_redefine.adoc b/tests/docs/no_namespace/16_5test_redefine.adoc index a158883..3ea98f6 100644 --- a/tests/docs/no_namespace/16_5test_redefine.adoc +++ b/tests/docs/no_namespace/16_5test_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: @@ -18,6 +19,7 @@ var3: [,yaml] ---- +--- version: '1.1' var1: redefine: true @@ -33,7 +35,7 @@ var3: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16_6choice_redefine.adoc b/tests/docs/no_namespace/16_6choice_redefine.adoc index b36a7bd..a21703e 100644 --- a/tests/docs/no_namespace/16_6choice_redefine.adoc +++ b/tests/docs/no_namespace/16_6choice_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' var: redefine: true @@ -13,6 +14,7 @@ var: [,yaml] ---- +--- version: '1.0' var: type: choice @@ -25,7 +27,7 @@ var: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/16exists_exists.adoc b/tests/docs/no_namespace/16exists_exists.adoc index 48b5d29..8c6ea5b 100644 --- a/tests/docs/no_namespace/16exists_exists.adoc +++ b/tests/docs/no_namespace/16exists_exists.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: New description @@ -11,13 +12,14 @@ var: [,yaml] ---- +--- version: '1.1' var: description: Description ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/17_5redefine_leadership.adoc b/tests/docs/no_namespace/17_5redefine_leadership.adoc index 8b41cc5..a02b2bb 100644 --- a/tests/docs/no_namespace/17_5redefine_leadership.adoc +++ b/tests/docs/no_namespace/17_5redefine_leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: redefine: true @@ -11,6 +12,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: # a leadership type: leadership diff --git a/tests/docs/no_namespace/20_0empty_family.adoc b/tests/docs/no_namespace/20_0empty_family.adoc index 2bf432c..8ae6bd6 100644 --- a/tests/docs/no_namespace/20_0empty_family.adoc +++ b/tests/docs/no_namespace/20_0empty_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' my_family: type: family diff --git a/tests/docs/no_namespace/20_0family_append.adoc b/tests/docs/no_namespace/20_0family_append.adoc index 62b981e..be12b50 100644 --- a/tests/docs/no_namespace/20_0family_append.adoc +++ b/tests/docs/no_namespace/20_0family_append.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: var2: @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: description: A family @@ -23,7 +25,7 @@ family: `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/20_0family_underscore.adoc b/tests/docs/no_namespace/20_0family_underscore.adoc index e18f2fd..1233c95 100644 --- a/tests/docs/no_namespace/20_0family_underscore.adoc +++ b/tests/docs/no_namespace/20_0family_underscore.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' my_family: _type: family diff --git a/tests/docs/no_namespace/20_0multi_family.adoc b/tests/docs/no_namespace/20_0multi_family.adoc index d035b88..20cc579 100644 --- a/tests/docs/no_namespace/20_0multi_family.adoc +++ b/tests/docs/no_namespace/20_0multi_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family subfamily: # a sub family @@ -19,7 +20,7 @@ family: # a family `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/20_0multi_family_basic.adoc b/tests/docs/no_namespace/20_0multi_family_basic.adoc index 8dbff91..91b8ee2 100644 --- a/tests/docs/no_namespace/20_0multi_family_basic.adoc +++ b/tests/docs/no_namespace/20_0multi_family_basic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family subfamily: # a sub family @@ -17,7 +18,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/20_0multi_family_expert.adoc b/tests/docs/no_namespace/20_0multi_family_expert.adoc index b5495aa..63dadfe 100644 --- a/tests/docs/no_namespace/20_0multi_family_expert.adoc +++ b/tests/docs/no_namespace/20_0multi_family_expert.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: description: a family diff --git a/tests/docs/no_namespace/20_0multi_family_order.adoc b/tests/docs/no_namespace/20_0multi_family_order.adoc index 6d129a3..967f7ff 100644 --- a/tests/docs/no_namespace/20_0multi_family_order.adoc +++ b/tests/docs/no_namespace/20_0multi_family_order.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' variable: # a variable family: # a family @@ -12,7 +13,7 @@ family: # a family ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -25,7 +26,7 @@ A variable. `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ A first variable. `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ A first variable. A variable. |==== -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc index e7f18ba..f63577c 100644 --- a/tests/docs/no_namespace/20_0validators_differ_redefine.adoc +++ b/tests/docs/no_namespace/20_0validators_differ_redefine.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var3: redefine: true @@ -16,6 +17,7 @@ var3: [,yaml] ---- +--- version: '1.1' var1: no # a first variable var2: no # a second variable @@ -33,7 +35,7 @@ var3: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/20_1empty_subfamily.adoc b/tests/docs/no_namespace/20_1empty_subfamily.adoc index a830ac2..2697f74 100644 --- a/tests/docs/no_namespace/20_1empty_subfamily.adoc +++ b/tests/docs/no_namespace/20_1empty_subfamily.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' my_family: my_sub_family: diff --git a/tests/docs/no_namespace/20_9default_information_parent.adoc b/tests/docs/no_namespace/20_9default_information_parent.adoc index 1d3eed7..9c3d511 100644 --- a/tests/docs/no_namespace/20_9default_information_parent.adoc +++ b/tests/docs/no_namespace/20_9default_information_parent.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 family: var1: # a first variable @@ -18,7 +19,7 @@ family: `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc index 4a4fc7a..9ed948e 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the variable use has condition family: @@ -17,7 +18,7 @@ family: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -29,7 +30,7 @@ The variable use has condition. + === possibly hidden family -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is yes. @@ -37,7 +38,7 @@ The variable use has condition. + `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md index 56f17a3..dce3a30 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_condition_sub_family.md @@ -27,7 +27,7 @@ family: ## possibly hidden family -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is yes. diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc index 834c103..ab66c00 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # the variable use has condition family: @@ -15,7 +16,7 @@ family: ---- == Variables -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -27,7 +28,7 @@ The variable use has condition. + === possibly hidden family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: when the variable "condition" has the value "True". @@ -35,7 +36,7 @@ The variable use has condition. + `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md index e243c2b..8f3f15c 100644 --- a/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_condition_variable_sub_family.md @@ -25,7 +25,7 @@ family: ## possibly hidden family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: when the variable "condition" has the value "True". diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc index fe84c36..63874ac 100644 --- a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # the variable use has condition family: @@ -20,7 +21,7 @@ family: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -32,7 +33,7 @@ The variable use has condition. + === possibly hidden family -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is yes. @@ -40,7 +41,7 @@ The variable use has condition. + `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md index 8520977..56550e2 100644 --- a/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md +++ b/tests/docs/no_namespace/24_0family_hidden_param_condition_sub_family.md @@ -30,7 +30,7 @@ family: ## possibly hidden family -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is yes. diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc index 7fa33b5..d0607d1 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition var: @@ -15,7 +16,7 @@ var: ---- == Variables -[cols="110a,110a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -25,7 +26,7 @@ A condition. + **Default**: no | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_mandatory_` | A variable. + **Mandatory**: only if rougail.condition has the value "yes". |==== diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition.md b/tests/docs/no_namespace/24_0family_mandatory_condition.md index c850956..424b868 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition.md @@ -22,6 +22,6 @@ var: | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: no | -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: only if rougail.condition has the value "yes". | diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc index 3dae420..8d35346 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: true # a condition var: @@ -11,7 +12,7 @@ var: ---- == Variables -[cols="110a,110a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -21,7 +22,7 @@ A condition. + **Default**: True | **var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` _`mandatory`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `standard` `_mandatory_` | A variable. + **Mandatory**: when the variable "condition" has the value "True". |==== diff --git a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md index 208933a..568ed91 100644 --- a/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md +++ b/tests/docs/no_namespace/24_0family_mandatory_condition_variable.md @@ -18,6 +18,6 @@ var: | Variable                                                                                                     | Description                                                                                                  | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **condition**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | A condition.
**Default**: True | -| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ | A variable.
**Mandatory**: when the variable "condition" has the value "True". | +| **var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* | A variable.
**Mandatory**: when the variable "condition" has the value "True". | diff --git a/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc b/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc index fc4f78b..2b8fd13 100644 --- a/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc +++ b/tests/docs/no_namespace/24_family_disabled_var_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: 1.1 family: diff --git a/tests/docs/no_namespace/40_0leadership.adoc b/tests/docs/no_namespace/40_0leadership.adoc index d3d05f7..b7c8e1d 100644 --- a/tests/docs/no_namespace/40_0leadership.adoc +++ b/tests/docs/no_namespace/40_0leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -19,7 +20,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_0leadership_diff_name.adoc b/tests/docs/no_namespace/40_0leadership_diff_name.adoc index f6cf77b..fe53c6e 100644 --- a/tests/docs/no_namespace/40_0leadership_diff_name.adoc +++ b/tests/docs/no_namespace/40_0leadership_diff_name.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leadership: description: a leadership @@ -19,7 +20,7 @@ leadership: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_0leadership_empty.adoc b/tests/docs/no_namespace/40_0leadership_empty.adoc index eadc65f..741f544 100644 --- a/tests/docs/no_namespace/40_0leadership_empty.adoc +++ b/tests/docs/no_namespace/40_0leadership_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' empty_leader: type: leadership diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc index 3e8a2f6..87dd825 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -24,7 +25,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc index 0c757fb..edf006a 100644 --- a/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc +++ b/tests/docs/no_namespace/40_0leadership_follower_default_value.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -21,7 +22,7 @@ leader: This family contains lists of variable blocks. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc index 2851367..c36e6b9 100644 --- a/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc +++ b/tests/docs/no_namespace/40_0leadership_leader_not_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- general: mode_conteneur_actif: type: string @@ -28,7 +29,7 @@ version: '1.0' `standard` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -49,7 +50,7 @@ No change. + This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_1leadership_append_follower.adoc b/tests/docs/no_namespace/40_1leadership_append_follower.adoc index b7a0b87..f8daa6d 100644 --- a/tests/docs/no_namespace/40_1leadership_append_follower.adoc +++ b/tests/docs/no_namespace/40_1leadership_append_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: follower3: @@ -11,6 +12,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -32,7 +34,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc index 75510fd..257b96c 100644 --- a/tests/docs/no_namespace/40_6leadership_follower_multi.adoc +++ b/tests/docs/no_namespace/40_6leadership_follower_multi.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leadership: description: A leadership @@ -27,7 +28,7 @@ leadership: This family contains lists of variable blocks. -[cols="119a,119a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_8calculation_boolean.adoc b/tests/docs/no_namespace/40_8calculation_boolean.adoc index ac72ad0..aa28e2a 100644 --- a/tests/docs/no_namespace/40_8calculation_boolean.adoc +++ b/tests/docs/no_namespace/40_8calculation_boolean.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' bool: false # a boolean variable multi1: @@ -33,7 +34,7 @@ multi2: ---- == Variables -[cols="129a,129a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc index 11269bf..36b29ab 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: description: a first variable @@ -13,7 +14,7 @@ var3: yes # a third variable ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc index cc748d6..4dbbccc 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: no # a variable fam1: # a family @@ -12,7 +13,7 @@ fam1: # a family ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -26,7 +27,7 @@ A variable. + `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc index 7495c7b..362fc6d 100644 --- a/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc +++ b/tests/docs/no_namespace/40_8calculation_multi_variable_parent2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' fam1: # first family var: no # a variable @@ -17,7 +18,7 @@ fam2: # second family `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -31,7 +32,7 @@ A variable. + `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/41_0choice_leader.adoc b/tests/docs/no_namespace/41_0choice_leader.adoc index 8913ac1..e1db091 100644 --- a/tests/docs/no_namespace/41_0choice_leader.adoc +++ b/tests/docs/no_namespace/41_0choice_leader.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: The leadership @@ -27,7 +28,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/44_0leadership_hidden.adoc b/tests/docs/no_namespace/44_0leadership_hidden.adoc index 6035ae2..adf33c9 100644 --- a/tests/docs/no_namespace/44_0leadership_hidden.adoc +++ b/tests/docs/no_namespace/44_0leadership_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: diff --git a/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc index fbd2146..fad00ea 100644 --- a/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc +++ b/tests/docs/no_namespace/44_0leadership_leader_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: diff --git a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc index ef0f10f..ce2f656 100644 --- a/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc +++ b/tests/docs/no_namespace/44_1leadership_append_hidden_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: follower3: @@ -12,6 +13,7 @@ leader: [,yaml] ---- +--- version: '1.1' leader: description: a leadership diff --git a/tests/docs/no_namespace/44_4leadership_mandatory.adoc b/tests/docs/no_namespace/44_4leadership_mandatory.adoc index 887a902..9afe630 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' leader: description: a leadership @@ -23,7 +24,7 @@ leader: This family contains lists of variable blocks. -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc index b6e39db..c1714cd 100644 --- a/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc +++ b/tests/docs/no_namespace/44_4leadership_mandatory_follower.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: a leadership @@ -23,7 +24,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc index d09ff3f..e6bba4c 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: no # a condition leader: @@ -21,7 +22,7 @@ leader: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -33,14 +34,14 @@ A condition. + === a leadership -`basic` _`hidden`_ +`basic` `_hidden_` **Hidden**: if condition is no. This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md index dfd8847..ea94850 100644 --- a/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md +++ b/tests/docs/no_namespace/44_5leadership_leader_hidden_calculation.md @@ -31,7 +31,7 @@ leader: ## a leadership -`basic` _`hidden`_ +`basic` *`hidden`* **Hidden**: if condition is no. diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc index 9146183..56f0429 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' condition: yes # a condition leader: @@ -21,7 +22,7 @@ leader: ---- == Variables -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ A condition. + This family contains lists of variable blocks. -[cols="118a,118a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ This family contains lists of variable blocks. A leader. | **leader.follower** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`disabled`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_disabled_` | A follower. + **Disabled**: if condition is yes. |==== diff --git a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md index bdf957f..e07551a 100644 --- a/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md +++ b/tests/docs/no_namespace/44_6leadership_follower_disabled_calculation.md @@ -39,6 +39,6 @@ This family contains lists of variable blocks. | Variable                                                                                                             | Description                                                                                                          | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **leader.leader**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | A leader. | -| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | A follower.
**Disabled**: if condition is yes. | +| **leader.follower**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | A follower.
**Disabled**: if condition is yes. | diff --git a/tests/docs/no_namespace/60_0family_dynamic.adoc b/tests/docs/no_namespace/60_0family_dynamic.adoc index 3c26f3f..4dfa689 100644 --- a/tests/docs/no_namespace/60_0family_dynamic.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable @@ -16,7 +17,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -38,7 +39,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc index 4d293c4..660b058 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_1_1.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable - val1 @@ -15,7 +16,7 @@ dyn: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -37,7 +38,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_dynamic_static.adoc b/tests/docs/no_namespace/60_0family_dynamic_static.adoc index 1b54269..a0919d0 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_static.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_static.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' dyn{{ identifier }}: description: a dynamic family @@ -24,7 +25,7 @@ This family builds families dynamically. * val1 * val2 -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_dynamic_test.adoc b/tests/docs/no_namespace/60_0family_dynamic_test.adoc index 0ecc46b..e686967 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_test.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_test.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: @@ -20,7 +21,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc index cb39993..3865143 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: [] # a suffix variable dyn{{ identifier }}: @@ -12,7 +13,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -30,7 +31,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc index ffc7bb9..e569ffe 100644 --- a/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc +++ b/tests/docs/no_namespace/60_0family_dynamic_variable_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A suffix variable - val1 @@ -14,7 +15,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -36,7 +37,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_0family_empty.adoc b/tests/docs/no_namespace/60_0family_empty.adoc index 895216f..a86d76a 100644 --- a/tests/docs/no_namespace/60_0family_empty.adoc +++ b/tests/docs/no_namespace/60_0family_empty.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' general2: type: family diff --git a/tests/docs/no_namespace/60_0family_hidden.adoc b/tests/docs/no_namespace/60_0family_hidden.adoc index b55cefc..60567a5 100644 --- a/tests/docs/no_namespace/60_0family_hidden.adoc +++ b/tests/docs/no_namespace/60_0family_hidden.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: redefine: true @@ -11,6 +12,7 @@ family: [,yaml] ---- +--- version: '1.1' family: # a family var: diff --git a/tests/docs/no_namespace/60_0family_mode.adoc b/tests/docs/no_namespace/60_0family_mode.adoc index b25eee8..0ca7f09 100644 --- a/tests/docs/no_namespace/60_0family_mode.adoc +++ b/tests/docs/no_namespace/60_0family_mode.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' family: # a family var: @@ -15,7 +16,7 @@ family: # a family `basic` -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc index e7a8f45..4cb4f56 100644 --- a/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc +++ b/tests/docs/no_namespace/60_1family_dynamic_jinja.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -18,7 +19,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -40,7 +41,7 @@ This family builds families dynamically. **Identifiers**: index of suffix value. -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc index 6310994..fd0cfc0 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a suffix variable - val1 @@ -21,7 +22,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -47,7 +48,7 @@ This family builds families dynamically. `basic` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -56,7 +57,7 @@ This family builds families dynamically. With a variable. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc index a6b552a..888b56f 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_jinja_fill_sub_group_2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a identifier variable - val1 @@ -25,7 +26,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -51,7 +52,7 @@ This family builds families dynamically. `standard` -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -61,7 +62,7 @@ A dynamic variable. + **Default**: the value of the identifier. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc index 63704ce..ccf0c8d 100644 --- a/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc +++ b/tests/docs/no_namespace/60_2family_dynamic_outside_calc.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: # a suffx variable - val1 @@ -20,7 +21,7 @@ newvar: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -42,7 +43,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var1". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ A dynamic variable. + **Default**: val |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc index 86bff66..71d4899 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix2.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -17,7 +18,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -39,7 +40,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc index 2107933..e3c9b3e 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_suffix_param.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # A identifier variable - val1 @@ -22,7 +23,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -44,7 +45,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc index bf672df..6d07e23 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_calc_variable.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var1: description: A suffix variable @@ -21,7 +22,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -43,7 +44,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var1". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -52,7 +53,7 @@ This family builds families dynamically. A dynamic variable. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc index a6e0e7a..899aaee 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' dyn{{ identifier }}: description: a dynamic family @@ -30,7 +31,7 @@ dyn{{ identifier }}: === a dynamic family -`standard` _`hidden`_ +`standard` `_hidden_` **Hidden**: if suffix == 'val2'. @@ -42,7 +43,7 @@ This family builds families dynamically. * val1 * val2 -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -55,7 +56,7 @@ A variable. `standard` -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md index 955c247..033ed5f 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md +++ b/tests/docs/no_namespace/60_5family_dynamic_hidden_suffix.md @@ -34,7 +34,7 @@ dyn{{ identifier }}: ## a dynamic family -`standard` _`hidden`_ +`standard` *`hidden`* **Hidden**: if suffix == 'val2'. diff --git a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc index 2f7f8ae..4f80514 100644 --- a/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc +++ b/tests/docs/no_namespace/60_5family_dynamic_variable_outside_suffix.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -21,7 +22,7 @@ var2: ---- == Variables -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -43,7 +44,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "var". -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -53,7 +54,7 @@ A variable inside dynamic family. + **Default**: the value of the identifier. |==== -[cols="108a,108a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc index 8955410..dae5f91 100644 --- a/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc +++ b/tests/docs/no_namespace/60_6family_dynamic_leadership.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: # a suffix variable - val1 @@ -25,7 +26,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -54,7 +55,7 @@ This family builds families dynamically. This family contains lists of variable blocks. -[cols="96a,96a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc index fc7386d..afb5c39 100644 --- a/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc +++ b/tests/docs/no_namespace/60_9family_dynamic_calc_both.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.1' var: val2 # a suffix variable dyn{{ identifier }}: @@ -13,7 +14,7 @@ dyn{{ identifier }}: ---- == Variables -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -35,7 +36,7 @@ This family builds families dynamically. * val1 * the value of the variable "var". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/docs/no_namespace/68_0family_leadership_mode.adoc b/tests/docs/no_namespace/68_0family_leadership_mode.adoc index 2738176..e538299 100644 --- a/tests/docs/no_namespace/68_0family_leadership_mode.adoc +++ b/tests/docs/no_namespace/68_0family_leadership_mode.adoc @@ -2,6 +2,7 @@ [,yaml] ---- +--- version: '1.0' leader: description: A leadership @@ -26,7 +27,7 @@ leader: This family contains lists of variable blocks. -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | diff --git a/tests/force_optional.adoc b/tests/force_optional.adoc index 412da19..ebf978b 100644 --- a/tests/force_optional.adoc +++ b/tests/force_optional.adoc @@ -1,6 +1,6 @@ == Variables for "rougail" -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description | @@ -15,12 +15,12 @@ My var2. + **Default**: var calculated. | **rougail.var3** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` | My var3. + **Hidden**: var could be hidden. | **rougail.var4** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` _`hidden`_ | +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` `_hidden_` | My var4. + **Hidden**: when the variable "a.unknown.variable" has the value "value". | @@ -57,7 +57,7 @@ This family builds families dynamically. **Identifiers**: the value of the variable "a.unknown.variable". -[cols="105a,105a",options="header"] +[cols="1a,1a"] |==== | Variable | Description |